Uploaded image for project: 'OFBiz'
  1. OFBiz
  2. OFBIZ-11350 Checkstyle improvements
  3. OFBIZ-11947

Checkstyle: Add Javadoc for classes designed for extension

    XMLWordPrintableJSON

    Details

    • Type: Sub-task
    • Status: Closed
    • Priority: Major
    • Resolution: Implemented
    • Affects Version/s: Trunk
    • Fix Version/s: Upcoming Branch
    • Component/s: ALL COMPONENTS
    • Labels:
      None
    • Sprint:
      OFBiz Community Day (May 2020), OFBiz Community Day (Aug 2020)

      Description

      For checkstyle errors:

      Class 'ResourceInfo' looks like designed for extension (can be subclassed), but the method 'createResourceHandler' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ResourceInfo' final or making the method 'createResourceHandler' static/final/abstract/empty, or adding allowed annotation for the method.

      We need to add missing javadocs for all such methods

        Attachments

        1. OFBIZ-11947-3.patch
          29 kB
          Suraj Khurana
        2. OFBIZ-11947-plugins-3.patch
          0.7 kB
          Suraj Khurana
        3. OFBIZ-11947-2.patch
          441 kB
          Suraj Khurana
        4. OFBIZ-11947.patch
          1.49 MB
          Suraj Khurana
        5. OFBIZ-11947-plugins.patch
          99 kB
          Suraj Khurana

          Activity

            People

            • Assignee:
              surajk Suraj Khurana
              Reporter:
              surajk Suraj Khurana
            • Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: