Merge pull request hoisie#65 from gtalent/master

hoisie · hoisie · commit 56fb5f666093 · 2011-05-08T21:16:07.000-07:00
Updated some function descriptions
diff --git a/web.go b/web.go
@@ -115,7 +115,7 @@ func getCookieSig(key string, val []byte, timestamp string) string {
 func (ctx *Context) SetSecureCookie(name string, val string, age int64) {
     //base64 encode the val
     if len(ctx.Server.Config.CookieSecret) == 0 {
-        ctx.Logger.Println("Secret Key for secure cookies has not been set. Please call web.SetCookieSecret")
+        ctx.Logger.Println("Secret Key for secure cookies has not been set. Please assign a cookie secret to web.Config.CookieSecret.")
         return
     }
     var buf bytes.Buffer
@@ -439,6 +439,7 @@ func (s *Server) initServer() {
     }
 }
 
+//Runs the web application and serves http requests
 func (s *Server) Run(addr string) {
     s.initServer()
 
@@ -461,7 +462,7 @@ func (s *Server) Run(addr string) {
     s.l.Close()
 }
 
-//runs the web application and serves http requests
+//Runs the web application and serves http requests
 func Run(addr string) {
     mainServer.Run(addr)
 }
@@ -472,7 +473,7 @@ func (s *Server) Close() {
     s.closed = true
 }
 
-//runs the web application and serves http requests
+//Stops the web server
 func Close() {
     mainServer.Close()
 }
@@ -483,18 +484,19 @@ func (s *Server) RunScgi(addr string) {
     s.listenAndServeScgi(addr)
 }
 
-//runs the web application and serves scgi requests
+//Runs the web application and serves scgi requests
 func RunScgi(addr string) {
     mainServer.RunScgi(addr)
 }
 
+//Runs the web application and serves scgi requests for this Server object.
 func (s *Server) RunFcgi(addr string) {
     s.initServer()
     s.Logger.Printf("web.go serving fcgi %s\n", addr)
     s.listenAndServeFcgi(addr)
 }
 
-//runs the web application by serving fastcgi requests
+//Runs the web application by serving fastcgi requests
 func RunFcgi(addr string) {
     mainServer.RunFcgi(addr)
 }

Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ func getCookieSig(key string, val []byte, timestamp string) string {`
`115`	`115`	`func (ctx *Context) SetSecureCookie(name string, val string, age int64) {`
`116`	`116`	`//base64 encode the val`
`117`	`117`	`if len(ctx.Server.Config.CookieSecret) == 0 {`
`118`		`- ctx.Logger.Println("Secret Key for secure cookies has not been set. Please call web.SetCookieSecret")`
	`118`	`+ ctx.Logger.Println("Secret Key for secure cookies has not been set. Please assign a cookie secret to web.Config.CookieSecret.")`
`119`	`119`	`return`
`120`	`120`	`}`
`121`	`121`	`var buf bytes.Buffer`
`@@ -439,6 +439,7 @@ func (s *Server) initServer() {`
`439`	`439`	`}`
`440`	`440`	`}`
`441`	`441`
	`442`	`+//Runs the web application and serves http requests`
`442`	`443`	`func (s *Server) Run(addr string) {`
`443`	`444`	`s.initServer()`
`444`	`445`
`@@ -461,7 +462,7 @@ func (s *Server) Run(addr string) {`
`461`	`462`	`s.l.Close()`
`462`	`463`	`}`
`463`	`464`
`464`		`-//runs the web application and serves http requests`
	`465`	`+//Runs the web application and serves http requests`
`465`	`466`	`func Run(addr string) {`
`466`	`467`	`mainServer.Run(addr)`
`467`	`468`	`}`
`@@ -472,7 +473,7 @@ func (s *Server) Close() {`
`472`	`473`	`s.closed = true`
`473`	`474`	`}`
`474`	`475`
`475`		`-//runs the web application and serves http requests`
	`476`	`+//Stops the web server`
`476`	`477`	`func Close() {`
`477`	`478`	`mainServer.Close()`
`478`	`479`	`}`
`@@ -483,18 +484,19 @@ func (s *Server) RunScgi(addr string) {`
`483`	`484`	`s.listenAndServeScgi(addr)`
`484`	`485`	`}`
`485`	`486`
`486`		`-//runs the web application and serves scgi requests`
	`487`	`+//Runs the web application and serves scgi requests`
`487`	`488`	`func RunScgi(addr string) {`
`488`	`489`	`mainServer.RunScgi(addr)`
`489`	`490`	`}`
`490`	`491`
	`492`	`+//Runs the web application and serves scgi requests for this Server object.`
`491`	`493`	`func (s *Server) RunFcgi(addr string) {`
`492`	`494`	`s.initServer()`
`493`	`495`	`s.Logger.Printf("web.go serving fcgi %s\n", addr)`
`494`	`496`	`s.listenAndServeFcgi(addr)`
`495`	`497`	`}`
`496`	`498`
`497`		`-//runs the web application by serving fastcgi requests`
	`499`	`+//Runs the web application by serving fastcgi requests`
`498`	`500`	`func RunFcgi(addr string) {`
`499`	`501`	`mainServer.RunFcgi(addr)`
`500`	`502`	`}`