Uploaded image for project: 'WildFly'
  1. WildFly
  2. WFLY-758

Identify modules with inadequate/missing JavaDoc

    Details

    • Type: Task
    • Status: Open (View Workflow)
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: Awaiting Volunteers
    • Component/s: None
    • Labels:
      None

      Description

      Criteria - All projects must have:

      1. An overview page
      2. Package JavaDoc for every package containing public classes
      3. Class JavaDoc for every public type (class, interface, annotation, exception, enum, etc.)
      4. Member JavaDoc for every public or protected type member, including nested types and their members
      5. JavaDoc for all generic type parameters on all protected and public types and methods of public and protected types
      6. JavaDoc for all method parameters on all protected and public constructors and methods of public and protected types
      7. JavaDoc for all return values of all non-void, public or protected methods on public or protected types
      8. 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

        Gliffy Diagrams

          Attachments

            Issue Links

              Activity

                People

                • Assignee:
                  Unassigned
                  Reporter:
                  dmlloyd David Lloyd
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  2 Start watching this issue

                  Dates

                  • Created:
                    Updated: