Browse Source

Improve JavaDocs.

Ben Alex 21 years ago
parent
commit
b485c40175
1 changed files with 4 additions and 1 deletions
  1. 4 1
      core/src/main/java/org/acegisecurity/adapters/AuthByAdapter.java

+ 4 - 1
core/src/main/java/org/acegisecurity/adapters/AuthByAdapter.java

@@ -35,7 +35,10 @@ public interface AuthByAdapter extends Authentication {
     //~ Methods ================================================================
 
     /**
-     * DOCUMENT ME!
+     * Returns the hash code of the key that was passed to the constructor of
+     * the <code>AuthByAdapter</code> implementation. The implementation
+     * should convert the value to a hash code at construction time, rather
+     * than storing the key itself.
      *
      * @return the hash code of the key used when the object was created.
      */