[BUILD-34] Add a few checkstyle rules (javadoc, imports) Created: 29/Jul/10  Updated: 13/Apr/17  Resolved: 03/Aug/10

Status: Closed
Project: Build
Component/s: None
Affects Version/s: None
Fix Version/s: Build Tools 1.5.5, POMs 16

Type: New Feature Priority: Major
Reporter: Magnolia International Assignee: Magnolia International
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
relation
is related to MAGNOLIA-3278 javadoc: satisfy new checkstyle rules... Closed
is related to MGNLCMNT-28 javadoc: satisfy new checkstyle rules... Closed
is related to MGNLDMS-192 javadoc: satisfy new checkstyle rules... Closed
Template:
Acceptance criteria:
Empty

 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)


Generated at Sun Feb 11 23:38:07 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.