Parameter tag has no description JAVA-D1005
Documentation
Major
6 months ago
—
a year old
@param tag for lowerBound does not have any description
65
66 }
67
68 /** 69 * Validates that the property holds an integer within the given lower and upper bounds. 70 * 71 * @param lowerBound 72 * @param upperBound 73 * @return An integer range validator 74 */ 75 public static ValidationCallback integerRangeValidator(int lowerBound, int upperBound) {
76 return new IntegerRangeValidator(lowerBound, upperBound);
77 }@param tag for upperBound does not have any description
65
66 }
67
68 /** 69 * Validates that the property holds an integer within the given lower and upper bounds. 70 * 71 * @param lowerBound 72 * @param upperBound 73 * @return An integer range validator 74 */ 75 public static ValidationCallback integerRangeValidator(int lowerBound, int upperBound) {
76 return new IntegerRangeValidator(lowerBound, upperBound);
77 }@param tag for configurationModel does not have any description
71 });
72 }
73
74 /** 75 * Creates a Toolkit with a title, and the given {@link ConfigurationModel}. 76 * 77 * @param title 78 * @param configurationModel 79 * 80 * @since 1.17 81 */ 82 public Toolkit(@Nonnull String title, ConfigurationModel configurationModel) {
83 Objects.requireNonNull(title);
84@param tag for title does not have any description
71 });
72 }
73
74 /** 75 * Creates a Toolkit with a title, and the given {@link ConfigurationModel}. 76 * 77 * @param title 78 * @param configurationModel 79 * 80 * @since 1.17 81 */ 82 public Toolkit(@Nonnull String title, ConfigurationModel configurationModel) {
83 Objects.requireNonNull(title);
84@param tag for parser does not have any description
40 private final String title;
41 private final ConfigurationModel configurationModel;
42
43 /** 44 * Create a Toolkit with a title, a static parser and static tokenizers. 45 * 46 * @param parser 47 * @param tokenizers 48 * @param title 49 * 50 * @deprecated in 1.17, use {@link #Toolkit(String, ConfigurationModel)} instead. 51 */ 52 @Deprecated(since = "1.17")
53 public Toolkit(final Parser parser, final List<Tokenizer> tokenizers, String title) {
54 this(title, new AbstractConfigurationModel() {
Description
This method/constructor has a parameter tag with no description.
Consider adding a description to the tag. If the parameter's name is clear enough, consider removing the parameter tag entirely.
Bad Practice
In the example below, there is an @param tag for the parameter someParam, but it does not attempt to describe the
parameter itself. An @param tag without a description is no better than omitting the tag entirely.
/**
* Some method.
*
* @param someParam
*/
String someMethod(int someParam) {
// ...
Recommended
Add a description to the tag.
/**
* Some method.
*
* @param someParam - Does something.
*
*/
String someMethod(int someParam) {
// ...
References
- Oracle technical blog - How to write JavaDoc comments