[jboss-jira] [JBoss JIRA] Updated: (JBAS-9029) Identify modules with inadequate/missing JavaDoc

David Lloyd (JIRA) jira-events at lists.jboss.org
Wed Mar 16 23:06:04 EDT 2011


     [ https://issues.jboss.org/browse/JBAS-9029?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

David Lloyd updated JBAS-9029:
------------------------------

    Description: 
Criteria - All projects must have:

# An overview page
# Package JavaDoc for every package containing public classes
# Class JavaDoc for every public type (class, interface, annotation, exception, enum, etc.)
# Member JavaDoc for every public or protected type member, including nested types and their members
# JavaDoc for all generic type parameters on all protected and public types and methods of public and protected types
# JavaDoc for all method parameters on all protected and public constructors and methods of public and protected types
# JavaDoc for all return values of all non-void, public or protected methods on public or protected types
# JavaDoc for all exceptions (checked or unchecked) which are declared to be thrown from a public or protected constructor or method on a public or protected type


> Identify modules with inadequate/missing JavaDoc
> ------------------------------------------------
>
>                 Key: JBAS-9029
>                 URL: https://issues.jboss.org/browse/JBAS-9029
>             Project: JBoss Application Server
>          Issue Type: Sub-task
>      Security Level: Public(Everyone can see) 
>            Reporter: David Lloyd
>             Fix For: 7.0.0.CR1
>
>
> Criteria - All projects must have:
> # An overview page
> # Package JavaDoc for every package containing public classes
> # Class JavaDoc for every public type (class, interface, annotation, exception, enum, etc.)
> # Member JavaDoc for every public or protected type member, including nested types and their members
> # JavaDoc for all generic type parameters on all protected and public types and methods of public and protected types
> # JavaDoc for all method parameters on all protected and public constructors and methods of public and protected types
> # JavaDoc for all return values of all non-void, public or protected methods on public or protected types
> # JavaDoc for all exceptions (checked or unchecked) which are declared to be thrown from a public or protected constructor or method on a public or protected type

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira


More information about the jboss-jira mailing list