Attachment 12712 Details for Bug 30231 – patch to improve source documentation

[patch] patch to improve source documentation

patch-user-type-doc.txt (text/plain), 3.51 KB, created by Joachim Wolfgang Kaltz on 2004-09-13 14:07:49 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Joachim Wolfgang Kaltz

Created: 2004-09-13 14:07:49 UTC

Size: 3.51 KB

patch

obsolete

>Index: src/java/org/apache/lenya/ac/UserType.java
>===================================================================
>--- src/java/org/apache/lenya/ac/UserType.java	(Revision 45973)
>+++ src/java/org/apache/lenya/ac/UserType.java	(Arbeitskopie)
>@@ -21,7 +21,6 @@
>  * A user type to be supported by the UserManager
>  * Note: the types are configured through access control (ac.xconf)
>  * 
>- * FIXME: jwkaltz@yahoo.com please add parameter descriptions to getters and setters.
>  * @version $Id:$
>  */
> public class UserType  {
>@@ -49,7 +48,8 @@
>     }
> 
>     /**
>-     * Get the key
>+     * Get the key to be used for this type. 
>+     * This key can be used for a dictionary entry for the user interface.
>      *
>      * @return a <code>String</code>
>      */
>@@ -58,7 +58,8 @@
>     }
>     
>     /**
>-     * Set the key
>+     * Set the key to be used for this type. 
>+     * This key can be used for a dictionary entry for the user interface.
>      *
>      * @param key the new key
>      */
>@@ -67,16 +68,24 @@
>     }
>     
>     /**
>-     * Get the className
>+     * Get the name of the class responsible for implementing this
>+     * type of user. Note that in current version, this field is for
>+     * information only; in later versions, it might be used for
>+     * introspection and dynamic script creation.
>      *
>-     * @return a <code>String</code>
>+     * @see org.apache.lenya.ac.file.FileUser
>+     * @see org.apache.lenya.ac.ldap.LDAPUser
>+     * @return a <code>String</code> the name of the class
>      */
>     public String getClassName() {
> 	  return className;
>     }
>     
>     /**
>-     * Set the className
>+     * Set the name of the class responsible for implementing this
>+     * type of user. Note that in current version, this field is for
>+     * information only; in later versions, it might be used for
>+     * introspection and dynamic flowscript creation.
>      *
>      * @param className the new className
>      */
>@@ -85,16 +94,22 @@
>     }
>     
>     /**
>-     * Get the createUseCase
>+     * Get the createUseCase name to be used when a user of this type
>+     * is to be created. 
>+     * This name will be used in the flowscript (currently: user-admin.js),
>+     * in order to distinguish between different types.
>      *
>-     * @return a <code>String</code>
>+     * @return a <code>String</code> the name of the use case in the flowscript
>      */
>     public String getCreateUseCase() {
> 	  return createUseCase;
>     }
>     
>     /**
>-     * Set the createUseCase
>+     * Set the createUseCase name to be used when a user of this type
>+     * is to be created. 
>+     * This name will be used in the flowscript (currently: user-admin.js),
>+     * in order to distinguish between different types.
>      *
>      * @param createUseCase the new createUseCase
>      */
>Index: src/webapp/lenya/pubs/default/config/ac/ac.xconf
>===================================================================
>--- src/webapp/lenya/pubs/default/config/ac/ac.xconf	(Revision 45973)
>+++ src/webapp/lenya/pubs/default/config/ac/ac.xconf	(Arbeitskopie)
>@@ -25,7 +25,7 @@
>     <user-manager>
>        <user-type class="org.apache.lenya.ac.file.FileUser" create-use-case="userAddUser">Local User</user-type>
>        
>-       
>+       
>     </user-manager>
>   </accreditable-manager>
>

Actions: View | Diff

Attachments on bug 30231: 12179 | 12239 | 12252 | 12693 | 12712