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

Checkstyle: Add override property in DesignForExtension module

    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

      While performing checks for class design it is mandatory to provide javadoc, we can skip override methods from this checkstyle check.

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

      <module name="DesignForExtension">
      <property name="ignoredAnnotations"
      value="After, AfterClass, Before, BeforeClass, Test, Property, Override"/>
      </module>

        Attachments

        1. OFBIZ-11941.patch
          0.6 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: