Uploaded image for project: 'SonarQube'
  1. SonarQube
  2. SONAR-4872

Deprecate "public_undocumented_api" metric

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 6.2
    • Component/s: Measures, Plugin API
    • Labels:
      None

      Description

      The reason why we should deprecate (and remove later) the "public_undocumented_api" metric is that we usually have a rule (like in Java for isntance) that checks for undocumented APIs. The issue is that exclusions/inclusions can be set on this rule, but not on the computation of the metric itself, which results in discrepancies.

      So:

      • this metric should be set as deprecated
      • its measure should be removed from the "Documentation and Comments" widget

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                teryk.bellahsene Teryk Bellahsene (Inactive)
                Reporter:
                fabemn OLD - Fabrice Bellingard
              • Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Due:
                  Created:
                  Updated:
                  Resolved: