[jira] [Commented] (DIRKRB-322) Adding JavaDoc for Class that implementing IdentityService

["Jiajia Li (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/DIRKRB-322?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14614497#comment-14614497 ] 

Jiajia Li commented on DIRKRB-322:
----------------------------------

Hi Yaning, just a advise, can you describe the javaDoc more details? 
For example:
{code}
/**
285	     * used to convert a dn of String to a Dn object
286	     * @param principalName
287	     * @return
288	     * @throws LdapInvalidDnException
289	     */
{code}
change to
{code}
/**
285	     * used to convert a dn of String to a Dn object
286	     * @param principalName The principal name to be convert
287	     * @return The Dn object
288	     * @throws LdapInvalidDnException if a remote exception occurs
289	     */
{code}


> Adding JavaDoc for Class that implementing IdentityService
> ----------------------------------------------------------
>
>                 Key: DIRKRB-322
>                 URL: https://issues.apache.org/jira/browse/DIRKRB-322
>             Project: Directory Kerberos
>          Issue Type: Improvement
>            Reporter: Xu Yaning
>         Attachments: DIRKRB-322-v1.patch
>
>
> Add JavaDoc for Class that implementing {{IdentityService}}, like {{AbstractIdentityBackend}}, {{JsonIdentityBackend}}, {{LdapIdentityBackend}}, {{MemoryIdentityBackend}} and {{ZookeeperIdentityBackend}}.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)