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

refactor javadocs in OFBiz to be standards compliant

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 17.12.01
    • Fix Version/s: 16.11.02
    • Component/s: ALL COMPONENTS
    • Labels:
      None
    • Sprint:
      2016 - OFBiz Community Day 4

      Description

      The OFBiz javadocs are not standard compliant and not legally correct which means that generating javadocs would fail. As a temporary workaround we added to the gradle build script:

       javadoc.failOnError = false

      However, the root solution would be to fix all the errors in javadocs and eventually remove the above code snippet from gradle. For more about compliance with javadocs you can read javadoc style document

      The best way to fix this issue is by:

      1. running "./gradlew javadoc"
      2. fixing the javadoc errors
      3. running "./gradlew javadoc" again and ensuring the errors are gone

      This is a large task (might need to be broken down to many sub-tasks). Any help is greatly appreciated!

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                mbrohl Michael Brohl
                Reporter:
                taher Taher Alkhateeb
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: