From b2f28a3ece30ff65d35ef9a10647cfde6e7df49e Mon Sep 17 00:00:00 2001
From: Sebastian Sdorra <sebastian.sdorra@cloudogu.com>
Date: Thu, 11 Oct 2012 16:14:22 +0200
Subject: [PATCH] javadoc for Tokens class

---
 scm-core/src/main/java/sonia/scm/security/Tokens.java | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/scm-core/src/main/java/sonia/scm/security/Tokens.java b/scm-core/src/main/java/sonia/scm/security/Tokens.java
index 0a619d825c..d9f668fa12 100644
--- a/scm-core/src/main/java/sonia/scm/security/Tokens.java
+++ b/scm-core/src/main/java/sonia/scm/security/Tokens.java
@@ -35,12 +35,14 @@ package sonia.scm.security;
 
 import org.apache.shiro.authc.AuthenticationToken;
 import org.apache.shiro.authc.UsernamePasswordToken;
+import org.apache.shiro.subject.Subject;
 
 //~--- JDK imports ------------------------------------------------------------
 
 import javax.servlet.http.HttpServletRequest;
 
 /**
+ * Create tokens for security reasons.
  *
  * @author Sebastian Sdorra
  * @since 1.21
@@ -49,12 +51,13 @@ public final class Tokens
 {
 
   /**
-   * Method description
+   * Build an {@link AuthenticationToken} for use with
+   * {@link Subject#login(org.apache.shiro.authc.AuthenticationToken)}.
    *
    *
-   * @param request
-   * @param username
-   * @param password
+   * @param request servlet request
+   * @param username username of the user to authenticate
+   * @param password password of the user to authenticate
    *
    * @return
    */