From 933e98e4f2a08bd73561fb82ac8cce702388d9f2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=82=85=E5=B0=8F=E9=BB=91?= <fuxiaohei@hexiaz.com>
Date: Fri, 20 Dec 2013 19:36:54 +0800
Subject: [PATCH] add api comments in file beego.go

---
 app.go   |  2 +-
 beego.go | 34 ++++++++++++++++++++++++++++------
 2 files changed, 29 insertions(+), 7 deletions(-)

diff --git a/app.go b/app.go
index a65fca1e..f71200cb 100644
--- a/app.go
+++ b/app.go
@@ -125,7 +125,7 @@ func (app *App) UrlFor(endpoint string, values ...string) string {
 	return app.Handlers.UrlFor(endpoint, values...)
 }
 
-// [Deprecated]
+// [Deprecated] use InsertFilter.
 // Filter adds a FilterFunc under pattern condition and named action.
 // The actions contains BeforeRouter,AfterStatic,BeforeExec,AfterExec and FinishRouter.
 func (app *App) Filter(pattern, action string, filter FilterFunc) *App {
diff --git a/beego.go b/beego.go
index 1b16a422..b2d22cc2 100644
--- a/beego.go
+++ b/beego.go
@@ -10,34 +10,50 @@ import (
 	"github.com/astaxie/beego/session"
 )
 
+// beego web framework version.
 const VERSION = "1.0.0"
 
+// Router adds a patterned controller handler to BeeApp.
+// it's an alias method of App.Router.
 func Router(rootpath string, c ControllerInterface, mappingMethods ...string) *App {
 	BeeApp.Router(rootpath, c, mappingMethods...)
 	return BeeApp
 }
 
+// RESTRouter adds a restful controller handler to BeeApp.
+// its' controller implements beego.ControllerInterface and
+// defines a param "pattern/:objectId" to visit each resource.
 func RESTRouter(rootpath string, c ControllerInterface) *App {
 	Router(rootpath, c)
 	Router(path.Join(rootpath, ":objectId"), c)
 	return BeeApp
 }
 
+// AutoRouter adds defined controller handler to BeeApp.
+// it's same to App.AutoRouter.
 func AutoRouter(c ControllerInterface) *App {
 	BeeApp.AutoRouter(c)
 	return BeeApp
 }
 
+// ErrorHandler registers http.HandlerFunc to each http err code string.
+// usage:
+// 	beego.ErrorHandler("404",NotFound)
+//	beego.ErrorHandler("500",InternalServerError)
 func Errorhandler(err string, h http.HandlerFunc) *App {
 	middleware.Errorhandler(err, h)
 	return BeeApp
 }
 
+// SetViewsPath sets view directory to BeeApp.
+// it's alias of App.SetViewsPath.
 func SetViewsPath(path string) *App {
 	BeeApp.SetViewsPath(path)
 	return BeeApp
 }
 
+// SetStaticPath sets static directory and url prefix to BeeApp.
+// it's alias of App.SetStaticPath.
 func SetStaticPath(url string, path string) *App {
 	if !strings.HasPrefix(url, "/") {
 		url = "/" + url
@@ -46,27 +62,33 @@ func SetStaticPath(url string, path string) *App {
 	return BeeApp
 }
 
+// DelStaticPath removes the static folder setting in this url pattern in beego application.
+// it's alias of App.DelStaticPath.
 func DelStaticPath(url string) *App {
 	delete(StaticDir, url)
 	return BeeApp
 }
 
-//!!DEPRECATED!! use InsertFilter
-//action has four values:
-//BeforRouter
-//AfterStatic
-//BeforExec
-//AfterExec
+// [Deprecated] use InsertFilter.
+// Filter adds a FilterFunc under pattern condition and named action.
+// The actions contains BeforeRouter,AfterStatic,BeforeExec,AfterExec and FinishRouter.
+// it's alias of App.Filter.
 func AddFilter(pattern, action string, filter FilterFunc) *App {
 	BeeApp.Filter(pattern, action, filter)
 	return BeeApp
 }
 
+// InsertFilter adds a FilterFunc with pattern condition and action constant.
+// The pos means action constant including
+// beego.BeforeRouter, beego.AfterStatic, beego.BeforeExec, beego.AfterExec and beego.FinishRouter.
+// it's alias of App.InsertFilter.
 func InsertFilter(pattern string, pos int, filter FilterFunc) *App {
 	BeeApp.InsertFilter(pattern, pos, filter)
 	return BeeApp
 }
 
+// Run beego application.
+// it's alias of App.Run.
 func Run() {
 	// if AppConfigPath not In the conf/app.conf reParse config
 	if AppConfigPath != filepath.Join(AppPath, "conf", "app.conf") {