Uploaded image for project: 'Build'
  1. Build
  2. BUILD-34

Add a few checkstyle rules (javadoc, imports)

    XMLWordPrintable

Details

    • New Feature
    • Resolution: Fixed
    • Major
    • Build Tools 1.5.5, POMs 16
    • None
    • None
    • None

    Description

      Will add the following:

      • JavadocType - enforces class-level javadoc -(make sure it's not enforced for tests)
      • JavadocStyle - enforce that there actually IS a javadoc comment, not just an empty /** */
      • AvoidStarImport - will still allow them for static imports
      • RedundantImport
      • UnusedImports

      Additionally, a change in the latest version of Checkstyle will make it so that the tab character check will be applied on all files, not just java sources anymore. ("New check FileTabCharacter for ensuring that any files does not contain a tab character. It replaces TabCharacterCheck which was restricted to Java files." as per http://checkstyle.sourceforge.net/releasenotes.html)

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                gjoseph Magnolia International
                gjoseph Magnolia International
                Votes:
                0 Vote for this issue
                Watchers:
                0 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved: