Scaladoc for Filter.apply

playframework · May 20, 2015 · 239387c · 239387c
1 parent 40df7af
commit 239387c
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/framework/src/play/src/main/scala/play/api/mvc/Filters.scala b/framework/src/play/src/main/scala/play/api/mvc/Filters.scala
@@ -26,6 +26,15 @@ trait Filter extends EssentialFilter {
 
   self =>
 
+  /**
+   * Apply the filter, given the request header and a function to call the next
+   * operation.
+   *
+   * @param f A function to call the next opertion. Call this to continue
+   * normally with the current request. You do not need to call this function
+   * if you want to generate a result in a different way.
+   * @param rh The RequestHeader.
+   */
   def apply(f: RequestHeader => Future[Result])(rh: RequestHeader): Future[Result]
 
   def apply(next: EssentialAction): EssentialAction = {