Documentataion cleanup
This commit is contained in:
parent
3f6d28e0ee
commit
b00cf9e4bd
|
@ -1,4 +1,11 @@
|
|||
/**
|
||||
* @namespace Typertext
|
||||
* @module Http
|
||||
*/
|
||||
module Typertext.Http {
|
||||
/**
|
||||
* @class HttpException
|
||||
*/
|
||||
export class HttpException extends Typertext.BaseException<HttpResponseStatus> {
|
||||
}
|
||||
}
|
|
@ -1,4 +1,11 @@
|
|||
/**
|
||||
* @namespace Typertext
|
||||
* @module Http
|
||||
*/
|
||||
module Typertext.Http {
|
||||
/**
|
||||
* @interface HttpHeaderData
|
||||
*/
|
||||
export interface HttpHeaderData {
|
||||
[index:string]:string
|
||||
}
|
||||
|
|
|
@ -1,4 +1,11 @@
|
|||
/**
|
||||
* @namespace Typertext
|
||||
* @module Http
|
||||
*/
|
||||
module Typertext.Http {
|
||||
/**
|
||||
* TODO figure out the proper annotations for enums
|
||||
*/
|
||||
export enum HttpMethod {
|
||||
GET,
|
||||
POST
|
||||
|
|
|
@ -1,4 +1,11 @@
|
|||
/**
|
||||
* @namespace Typertext
|
||||
* @module Http
|
||||
*/
|
||||
module Typertext.Http {
|
||||
/**
|
||||
* @interface HttpPostData
|
||||
*/
|
||||
export interface HttpPostData {
|
||||
[index:string]:string
|
||||
}
|
||||
|
|
|
@ -1,3 +1,7 @@
|
|||
/**
|
||||
* @namespace Typertext
|
||||
* @module Http
|
||||
*/
|
||||
module Typertext.Http {
|
||||
export enum HttpProtocol {
|
||||
http,
|
||||
|
|
|
@ -1,4 +1,11 @@
|
|||
/**
|
||||
* @namespace Typertext
|
||||
* @module Http
|
||||
*/
|
||||
module Typertext.Http {
|
||||
/**
|
||||
* @interface HttpQueryString
|
||||
*/
|
||||
export interface HttpQueryString {
|
||||
[index:string]:string
|
||||
}
|
||||
|
|
|
@ -1,4 +1,11 @@
|
|||
/**
|
||||
* @namespace Typertext
|
||||
* @module Http
|
||||
*/
|
||||
module Typertext.Http {
|
||||
/**
|
||||
* @interface HttpResponseHandler
|
||||
*/
|
||||
export interface HttpResponseHandler extends Typertext.GenericResponseHandler<HttpResponse> {
|
||||
}
|
||||
}
|
|
@ -1,3 +1,7 @@
|
|||
/**
|
||||
* @namespace Typertext
|
||||
* @module Http
|
||||
*/
|
||||
module Typertext.Http {
|
||||
export enum HttpResponseStatus {
|
||||
success,
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -1,4 +1,11 @@
|
|||
/**
|
||||
* @namespace Typertext
|
||||
* @module Json
|
||||
*/
|
||||
module Typertext.Json {
|
||||
/**
|
||||
* @interface JsonObject
|
||||
*/
|
||||
export interface JsonObject {
|
||||
[index:string]:any
|
||||
}
|
||||
|
|
|
@ -1,4 +1,11 @@
|
|||
/**
|
||||
* @namespace Typertext
|
||||
* @module Json
|
||||
*/
|
||||
module Typertext.Json {
|
||||
/**
|
||||
* @interface JsonResponseHandler
|
||||
*/
|
||||
export interface JsonResponseHandler extends Typertext.GenericResponseHandler<JsonResponse> {
|
||||
}
|
||||
}
|
Reference in a new issue