SonarQube Java
  1. SonarQube Java
  2. SONARJAVA-265

The "Undocumented API" rule should log a violation when a @Param or @Return tag is missing

    Details

    • Type: Improvement Improvement
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.4
    • Component/s: Rules
    • Labels:
      None
    • Number of attachments :
      0

      Description

      Example:

      /**
      * blabla
      * @return the converted string
      */
      public int convert(String value){...}   //Non-Compliant, '@param value' is missing
      
      /**
      * blabla
      * @param value String to be converted
      */
      public int convert(String value){...}   //Non-Compliant, '@return' is missing
      

        Issue Links

          Activity

          Hide
          Dinesh Bolkensteyn added a comment -

          Should work now!

          Show
          Dinesh Bolkensteyn added a comment - Should work now!
          Hide
          Freddy Mallet added a comment -

          We should log only one violation by method and not one by missing @Param and @Return tag.

          Show
          Freddy Mallet added a comment - We should log only one violation by method and not one by missing @Param and @Return tag.
          Hide
          Dinesh Bolkensteyn added a comment -

          As discussed, it will be sufficient to log just a single issue for all parameters.

          Show
          Dinesh Bolkensteyn added a comment - As discussed, it will be sufficient to log just a single issue for all parameters.
          Hide
          Dinesh Bolkensteyn added a comment -
          Show
          Dinesh Bolkensteyn added a comment - Implements http://jira.sonarsource.com/browse/RSPEC-1176
          Hide
          Dinesh Bolkensteyn added a comment -

          Fixed

          Show
          Dinesh Bolkensteyn added a comment - Fixed
          Hide
          Freddy Mallet added a comment -

          Manually tested !

          Show
          Freddy Mallet added a comment - Manually tested !

            People

            • Assignee:
              Dinesh Bolkensteyn
              Reporter:
              Freddy Mallet
            • Votes:
              1 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: