From b485c4017598681062607775330e07933a4519bc Mon Sep 17 00:00:00 2001
From: Ben Alex <ben.alex@springsource.com>
Date: Fri, 26 Mar 2004 11:05:55 +0000
Subject: [PATCH] Improve JavaDocs.

---
 .../main/java/org/acegisecurity/adapters/AuthByAdapter.java  | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/core/src/main/java/org/acegisecurity/adapters/AuthByAdapter.java b/core/src/main/java/org/acegisecurity/adapters/AuthByAdapter.java
index c277dae473..782b2f29c5 100644
--- a/core/src/main/java/org/acegisecurity/adapters/AuthByAdapter.java
+++ b/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.
      */