Merge pull request #1140 from cr7pt0gr4ph7/doc-pull-request

Improve documentation of filter.go.

filter.go

@@ -16,11 +16,12 @@ package beego
 
 import "github.com/astaxie/beego/context"
 
-// FilterFunc defines filter function type.
+// FilterFunc defines a filter function which is invoked before the controller handler is executed.
 type FilterFunc func(*context.Context)
 
-// FilterRouter defines filter operation before controller handler execution.
-// it can match patterned url and do filter function when action arrives.
+// FilterRouter defines a filter operation which is invoked before the controller handler is executed.
+// It can match the URL against a pattern, and execute a filter function
+// when a request with a matching URL arrives.
 type FilterRouter struct {
 	filterFunc     FilterFunc
 	tree           *Tree
@@ -28,10 +29,11 @@ type FilterRouter struct {
 	returnOnOutput bool
 }
 
-// ValidRouter check current request is valid for this filter.
-// if matched, returns parsed params in this request by defined filter router pattern.
-func (f *FilterRouter) ValidRouter(router string) (bool, map[string]string) {
-	isok, params := f.tree.Match(router)
+// ValidRouter checks if the current request is matched by this filter.
+// If the request is matched, the values of the URL parameters defined
+// by the filter pattern are also returned.
+func (f *FilterRouter) ValidRouter(url string) (bool, map[string]string) {
+	isok, params := f.tree.Match(url)
 	if isok == nil {
 		return false, nil
 	}