Permalink
Browse files

Fixing/Updating javadocs

  • Loading branch information...
1 parent 7e00842 commit d77f2e6055567507fec0689d43a22519510ea784 @tucu00 tucu00 committed Jan 23, 2011
View
@@ -1,5 +1,6 @@
-- Alfredo 0.1.1 release
+- Fixing/Updating javadocs
- Add version number var to doc pages
- Reorganizing docs layout for multiple releases
- Normalizing configuration property names
@@ -41,7 +41,7 @@
* <p/>
* The usage pattern of the <code>AuthenticatedURL</code> is:
* <p/>
- * <verbatim>
+ * <pre>
*
* // establishing an initial connection
*
@@ -60,7 +60,7 @@
* // use the 'conn' instance
* ....
*
- * </verbatim>
+ * </pre>
*/
public class AuthenticatedURL {
@@ -57,12 +57,12 @@
* <ul>
* <li>config.prefix: indicates the prefix to be used by all other configuration properties, the default value
* is no prefix. See below for details on how/why this prefix is used.</li>
- * <li>#PREFIX#.authentication.type: simple|kerberos|#CLASS#, 'simple' is short for the
+ * <li>[#PREFIX#.]type: simple|kerberos|#CLASS#, 'simple' is short for the
* {@link PseudoAuthenticationHandler}, 'kerberos' is short for {@link KerberosAuthenticationHandler}, otherwise
* the full class name of the {@link AuthenticationHandler} must be specified.</li>
- * <li>#PREFIX#.signature.secret: the secret used to sign the HTTP Cookie value, the default value is a random
+ * <li>[#PREFIX#.]signature.secret: the secret used to sign the HTTP Cookie value, the default value is a random
* value (unless multiple webapp instances need to share the secret the random value is adequate.</li>
- * <li>auth.token.validity: validity -in seconds- of the generated token is valid before a
+ * <li>[#PREFIX#.]token.validity: validity -in seconds- of the generated token is valid before a
* new authentication is triggered, default value is <code>3600</code> seconds</li>
* </ul>
* <p/>
@@ -37,7 +37,7 @@
* <p/>
* The supported configuration property is:
* <ul>
- * <li>annonymous.allowed: <code>true|false</code>, default value is <code>false</code></li>
+ * <li>simple.annonymous.allowed: <code>true|false</code>, default value is <code>false</code></li>
* </ul>
*/
public class PseudoAuthenticationHandler implements AuthenticationHandler {

0 comments on commit d77f2e6

Please sign in to comment.