Sonar

Method public should not be counted a undocumented API when inherited

Details

  • Type: Improvement Improvement
  • Status: Open Open
  • Priority: Major Major
  • Resolution: Unresolved
  • Affects Version/s: None
  • Fix Version/s: None
  • Component/s: Squid
  • Labels:
    None
  • Number of attachments :
    0

Description

When I override a public method, I am not expecting that I should comment it.
When a public method is deprecated, I am not expecting that I should comment it

Issue Links

This issue is duplicated by:
SONAR-807 Ability to define patterns in order to prevent classes/methods from being considered as API Major Closed
This issue is related to:
SONAR-881 Use @Override annotation to avoid counting undocumentedAPI when overriding public API Major Closed

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Olivier Gaudin added a comment -

Decreasing the priority as sonar-884 has been implemented and will go into 1.12

Show
Olivier Gaudin added a comment - Decreasing the priority as sonar-884 has been implemented and will go into 1.12
Hide
Permalink
Oliver Gierke added a comment -

I don't really get hom 884 (http://jira.codehaus.org/browse/SONAR-884) relates to this one.

I don't agree on deprecated methods not being required to be documented as IMHO it's necessary for developers wanting to use functionality formerly implemented by a now deprecated method to know, what API to use instead.

Show
Oliver Gierke added a comment - I don't really get hom 884 (http://jira.codehaus.org/browse/SONAR-884) relates to this one. I don't agree on deprecated methods not being required to be documented as IMHO it's necessary for developers wanting to use functionality formerly implemented by a now deprecated method to know, what API to use instead.
Hide
Permalink
Olivier Gaudin added a comment -

Oups ! I meant SONAR-881

Show
Olivier Gaudin added a comment - Oups ! I meant SONAR-881
Hide
Permalink
Oliver Gierke added a comment -

Ah, that makes perfect sense

Show
Oliver Gierke added a comment - Ah, that makes perfect sense
Hide
Permalink
Simon Brandhof added a comment -

I agree with Oliver, deprecated methods MUST be documented.

Show
Simon Brandhof added a comment - I agree with Oliver, deprecated methods MUST be documented.

People

Vote (7)
Watch (1)

Dates

  • Created:
    Updated:
Atlassian JIRA (v4.4.3#663-r165197) | Report a problem
Powered by a free Atlassian JIRA open source license for Codehaus. Try JIRA - bug tracking software for your team.