Documentataion cleanup

This commit is contained in:
Kegan Myers 2014-02-28 11:45:01 -06:00
parent 3f6d28e0ee
commit b00cf9e4bd
12 changed files with 67 additions and 5 deletions

View file

@ -1,4 +1,11 @@
/**
* @namespace Typertext
* @module Http
*/
module Typertext.Http {
/**
* @class HttpException
*/
export class HttpException extends Typertext.BaseException<HttpResponseStatus> {
}
}

View file

@ -1,4 +1,11 @@
/**
* @namespace Typertext
* @module Http
*/
module Typertext.Http {
/**
* @interface HttpHeaderData
*/
export interface HttpHeaderData {
[index:string]:string
}

View file

@ -1,4 +1,11 @@
/**
* @namespace Typertext
* @module Http
*/
module Typertext.Http {
/**
* TODO figure out the proper annotations for enums
*/
export enum HttpMethod {
GET,
POST

View file

@ -1,4 +1,11 @@
/**
* @namespace Typertext
* @module Http
*/
module Typertext.Http {
/**
* @interface HttpPostData
*/
export interface HttpPostData {
[index:string]:string
}

View file

@ -1,3 +1,7 @@
/**
* @namespace Typertext
* @module Http
*/
module Typertext.Http {
export enum HttpProtocol {
http,

View file

@ -1,4 +1,11 @@
/**
* @namespace Typertext
* @module Http
*/
module Typertext.Http {
/**
* @interface HttpQueryString
*/
export interface HttpQueryString {
[index:string]:string
}

View file

@ -1,4 +1,11 @@
/**
* @namespace Typertext
* @module Http
*/
module Typertext.Http {
/**
* @interface HttpResponseHandler
*/
export interface HttpResponseHandler extends Typertext.GenericResponseHandler<HttpResponse> {
}
}

View file

@ -1,3 +1,7 @@
/**
* @namespace Typertext
* @module Http
*/
module Typertext.Http {
export enum HttpResponseStatus {
success,

View file

@ -13,14 +13,9 @@ module Typertext.Http {
};
/**
* A common interface for building a URL into something that can easily be decomposed for a client
*
* @param protocol
* @returns {number}
*
* @author Kegan Myers <kegan@keganmyers.com>
* @version 0.3.0
* @constructor
*/
public static DefaultPort(protocol:HttpProtocol) {
return ((protocol == HttpProtocol.http) ? 80 : 443)
@ -122,6 +117,7 @@ module Typertext.Http {
}
/**
* A common interface for building a URL into something that can easily be decomposed for a client
*
* @param {string} domain
* @param {HttpProtocol} protocol
@ -129,6 +125,7 @@ module Typertext.Http {
* @param {HttpQueryString} queryString
* @param {number} port
*
* @class HttpUrl
* @author Kegan Myers <kegan@keganmyers.com>
* @version 0.3.0
* @constructor

View file

@ -10,6 +10,7 @@ module Typertext.Json {
* @param {string} message
* @param {number} code
*
* @class JsonException
* @author Kegan Myers <kegan@keganmyers.com>
* @version 0.3.0
* @constructor

View file

@ -1,4 +1,11 @@
/**
* @namespace Typertext
* @module Json
*/
module Typertext.Json {
/**
* @interface JsonObject
*/
export interface JsonObject {
[index:string]:any
}

View file

@ -1,4 +1,11 @@
/**
* @namespace Typertext
* @module Json
*/
module Typertext.Json {
/**
* @interface JsonResponseHandler
*/
export interface JsonResponseHandler extends Typertext.GenericResponseHandler<JsonResponse> {
}
}