add comments for context package.

context/output.go

@@ -17,20 +17,27 @@ import (
 	"strings"
 )
 
+// BeegoOutput does work for sending response header.
 type BeegoOutput struct {
 	Context    *Context
 	Status     int
 	EnableGzip bool
 }
 
+// NewOutput returns new BeegoOutput.
+// it contains nothing now.
 func NewOutput() *BeegoOutput {
 	return &BeegoOutput{}
 }
 
+// Header sets response header item string via given key.
 func (output *BeegoOutput) Header(key, val string) {
 	output.Context.ResponseWriter.Header().Set(key, val)
 }
 
+// Body sets response body content.
+// if EnableGzip, compress content string.
+// it sends out response body directly.
 func (output *BeegoOutput) Body(content []byte) {
 	output_writer := output.Context.ResponseWriter.(io.Writer)
 	if output.EnableGzip == true && output.Context.Input.Header("Accept-Encoding") != "" {
@@ -64,6 +71,8 @@ func (output *BeegoOutput) Body(content []byte) {
 	}
 }
 
+// Cookie sets cookie value via given key.
+// others are ordered as cookie's max age time, path,domain, secure and httponly.
 func (output *BeegoOutput) Cookie(name string, value string, others ...interface{}) {
 	var b bytes.Buffer
 	fmt.Fprintf(&b, "%s=%s", sanitizeName(name), sanitizeValue(value))
@@ -116,6 +125,8 @@ func sanitizeValue(v string) string {
 	return cookieValueSanitizer.Replace(v)
 }
 
+// Json writes json to response body.
+// if coding is true, it converts utf-8 to \u0000 type.
 func (output *BeegoOutput) Json(data interface{}, hasIndent bool, coding bool) error {
 	output.Header("Content-Type", "application/json;charset=UTF-8")
 	var content []byte
@@ -136,6 +147,7 @@ func (output *BeegoOutput) Json(data interface{}, hasIndent bool, coding bool) e
 	return nil
 }
 
+// Jsonp writes jsonp to response body.
 func (output *BeegoOutput) Jsonp(data interface{}, hasIndent bool) error {
 	output.Header("Content-Type", "application/javascript;charset=UTF-8")
 	var content []byte
@@ -161,6 +173,7 @@ func (output *BeegoOutput) Jsonp(data interface{}, hasIndent bool) error {
 	return nil
 }
 
+// Xml writes xml string to response body.
 func (output *BeegoOutput) Xml(data interface{}, hasIndent bool) error {
 	output.Header("Content-Type", "application/xml;charset=UTF-8")
 	var content []byte
@@ -178,6 +191,8 @@ func (output *BeegoOutput) Xml(data interface{}, hasIndent bool) error {
 	return nil
 }
 
+// Download forces response for download file.
+// it prepares the download response header automatically.
 func (output *BeegoOutput) Download(file string) {
 	output.Header("Content-Description", "File Transfer")
 	output.Header("Content-Type", "application/octet-stream")
@@ -189,6 +204,8 @@ func (output *BeegoOutput) Download(file string) {
 	http.ServeFile(output.Context.ResponseWriter, output.Context.Request, file)
 }
 
+// ContentType sets the content type from ext string.
+// MIME type is given in mime package.
 func (output *BeegoOutput) ContentType(ext string) {
 	if !strings.HasPrefix(ext, ".") {
 		ext = "." + ext
@@ -199,43 +216,63 @@ func (output *BeegoOutput) ContentType(ext string) {
 	}
 }
 
+// SetStatus sets response status code.
+// It writes response header directly.
 func (output *BeegoOutput) SetStatus(status int) {
 	output.Context.ResponseWriter.WriteHeader(status)
 	output.Status = status
 }
 
+// IsCachable returns boolean of this request is cached.
+// HTTP 304 means cached.
 func (output *BeegoOutput) IsCachable(status int) bool {
 	return output.Status >= 200 && output.Status < 300 || output.Status == 304
 }
 
+// IsEmpty returns boolean of this request is empty.
+// HTTP 201，204 and 304 means empty.
 func (output *BeegoOutput) IsEmpty(status int) bool {
 	return output.Status == 201 || output.Status == 204 || output.Status == 304
 }
 
+// IsOk returns boolean of this request runs well.
+// HTTP 200 means ok.
 func (output *BeegoOutput) IsOk(status int) bool {
 	return output.Status == 200
 }
 
+// IsSuccessful returns boolean of this request runs successfully.
+// HTTP 2xx means ok.
 func (output *BeegoOutput) IsSuccessful(status int) bool {
 	return output.Status >= 200 && output.Status < 300
 }
 
+// IsRedirect returns boolean of this request is redirection header.
+// HTTP 301,302,307 means redirection.
 func (output *BeegoOutput) IsRedirect(status int) bool {
 	return output.Status == 301 || output.Status == 302 || output.Status == 303 || output.Status == 307
 }
 
+// IsForbidden returns boolean of this request is forbidden.
+// HTTP 403 means forbidden.
 func (output *BeegoOutput) IsForbidden(status int) bool {
 	return output.Status == 403
 }
 
+// IsNotFound returns boolean of this request is not found.
+// HTTP 404 means forbidden.
 func (output *BeegoOutput) IsNotFound(status int) bool {
 	return output.Status == 404
 }
 
+// IsClient returns boolean of this request client sends error data.
+// HTTP 4xx means forbidden.
 func (output *BeegoOutput) IsClientError(status int) bool {
 	return output.Status >= 400 && output.Status < 500
 }
 
+// IsServerError returns boolean of this server handler errors.
+// HTTP 5xx means server internal error.
 func (output *BeegoOutput) IsServerError(status int) bool {
 	return output.Status >= 500 && output.Status < 600
 }
@@ -254,6 +291,7 @@ func stringsToJson(str string) string {
 	return jsons
 }
 
+// Sessions sets session item value with given key.
 func (output *BeegoOutput) Session(name interface{}, value interface{}) {
 	output.Context.Input.CruSession.Set(name, value)
 }