Uploaded image for project: 'HBase'
  1. HBase
  2. HBASE-14890 Fix javadoc checkstyle errors
  3. HBASE-14902

Revert some of the stringency recently introduced by checkstyle tightening

    XMLWordPrintableJSON

Details

    • Sub-task
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • None
    • 2.0.0
    • None
    • None
    • Reviewed
    • Changes the checkstyle so that on a continuation line for javadoc, instead of default four spaces, instead now it is two spaces. Also one line statements as in if (true) x =1; now pass checkstyle.

    Description

      I think we should undo some of the plugins that were recently added to checkstyle. They are too much.

      JavadocTagContinuationIndentationCheck is about adding indent if javadoc is two lines or more (javadoc tool doesn't care)

      NonEmptyAtclauseDescriptionCheck would have us add javadoc on each exception: e.g. @throws IOException needs to have text added.

      NeedBracesCheck has us undoing cases where an if fits all on one line (don't want to start style wars but if short and fits on one line, I think its more readable... but I could relent on this one.... ).

      The first two at least should go.

      You ok w/ that appy

      Attachments

        1. 14902.part1.patch
          0.6 kB
          Michael Stack
        2. 14902.patch
          1 kB
          Michael Stack
        3. 14902.patch
          1 kB
          Michael Stack
        4. braces.patch
          0.7 kB
          Michael Stack

        Activity

          People

            stack Michael Stack
            stack Michael Stack
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: