Undocumented constructor found JAVA-D1002
Documentation
Minor
6 months ago
—
2 years old
Consider adding a doc comment for DroppedPropertiesSensor
41 private static final Map<String, String> ALL_REMOVED_PROPERTIES = initRemovedProperties();
42 private final AnalysisWarnings analysisWarnings;
43
44 public DroppedPropertiesSensor(AnalysisWarnings analysisWarnings) { 45 this.analysisWarnings = analysisWarnings; 46 } 47
48 private static Map<String, String> initRemovedProperties() {
49 var map = new HashMap<String, String>();Consider adding a doc comment for CxxLanguage
59 */
60 private final Configuration config;
61
62 public CxxLanguage(Configuration config) { 63 super(KEY, NAME); 64 this.config = config; 65 } 66
67 public static List<PropertyDefinition> properties() {
68 return Collections.unmodifiableList(Arrays.asList(Consider adding a doc comment for CxxChecks
37 private final CheckFactory checkFactory;
38 private final Set<Checks<SquidAstVisitor<Grammar>>> checksByRepository = new HashSet<>();
39
40 private CxxChecks(CheckFactory checkFactory) {41 this.checkFactory = checkFactory;42 }43
44 public static CxxChecks createCxxCheck(CheckFactory checkFactory) {
45 return new CxxChecks(checkFactory);Consider adding a doc comment for AstNodeXPathQuery
35 private final AstNodeNavigator astNodeNavigator = new AstNodeNavigator();
36 private final BaseXPath expression;
37
38 private AstNodeXPathQuery(String xpath) { 39 try { 40 expression = new BaseXPath(xpath, astNodeNavigator); 41 } catch (JaxenException e) { 42 throw new RuntimeException(e); 43 } 44 } 45
46 /**
47 * Evaluate the XPath query on the given AstNode and returns the first result, or null if there was no result.Consider adding a doc comment for Attribute
263 private final String name;
264 private final AstNode astNode;
265
266 public Attribute(String name, AstNode astNode) {267 this.name = name;268 this.astNode = astNode;269 }270
271 public String getName() {
272 return name;
Description
This constructor does not have any documentation.
Consider adding a documentation comment to explain its use.
While it may seem like the usage of a constructor is perfectly obvious, any consumers of your API may not be able to pick up on certain details.
Bad Practice
In the example below, it is difficult to understand what the arguments of this constructor for DataForwarder signify.
class DataForwarder {
public DataForwarder(int nTypes, String... values) {
// ...
}
}
Recommended
Document the constructor and provide useful information about it or its parameters as required.
/**
* Initializes a DataForwarder with a set of types to filter by, along with their names.
*
* @param nTypes - The number of types to filter by.
* @param values - The input type names to filter by.
*/
public DataForwarder(int nTypes, String... values) {
// ...
}
Exceptions
If you feel this constructor does not require documentation, you can add a skipcq comment to this constructor.