Uploaded image for project: 'OFBiz'
  1. OFBiz
  2. OFBIZ-9148

Check and enhance the Javadoc rules/documentation for the project

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Open
    • Minor
    • Resolution: Unresolved
    • None
    • None
    • Confluence
    • None

    Description

      We are currently working on a huge amount of invalid Javadoc entries in our codebase. We'll have to check if we already have some documentation on how to writer proper Javadoc and how to avoid the biggest mistakes and maybe enhance it.

      We also have to check the Javadoc during review of contributions and should ask for creation or correction of proper Javadoc just like we do with code.

      Attachments

        Issue Links

          is a child of

          Task - A task that needs to be done. OFBIZ-10285 OFBiz Documentation Global Task

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open
          relates to

          Improvement - An improvement or enhancement to an existing feature or task. OFBIZ-9144 refactor javadocs in OFBiz to be standards compliant

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Closed

          Activity

            People

              mbrohl Michael Brohl
              mbrohl Michael Brohl
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated: