Uploaded image for project: 'SonarJava'
  1. SonarJava
  2. SONARJAVA-2586

S1130 should not raise issue when exception is documented but not thrown + S1172 behavior change on documented unused parameters

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 5.3
    • Component/s: Rules
    • Labels:
      None

      Description

      To be consistent with the change introduced in SONARJAVA-2443 for unused parameter, exception which is documented in javadoc should not be reported by RSPEC-1130, if method is intended to be overridden (i.e has public or protected modifier and it's not final).

      Also, to be fully consistent with other rules involving javadoc, what is meant for a tag to have "proper javadoc", is not only to have the corresponding tag of the element in the javadoc, but also that this tag has a description associated with it.

      Thus, behaviour of rule S1172 has been slightly altered too, as now unused parameter also need to have a description in the javadoc to be considered valid javadoc

        Attachments

          Activity

            People

            • Assignee:
              christophe.zurn Christophe Zurn
              Reporter:
              tibor.blenessy Tibor Blenessy
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Due:
                Created:
                Updated:
                Resolved: