Fix javadoc failure#1350
Conversation
|
Assuming you're working on javadoc error fix (Thank you!), you want to focus on the "errors: " lines rather than "warnings: ". Note that the warnings for javadoc may not match Google's coding convention. In that case you don't have to fix warnings.
|
|
Warning: This pull request is touching the following templated files:
|
tom-andersen
left a comment
There was a problem hiding this comment.
I am a little confused why the the java files in the collection folder need to be changed. These are internal from what I can tell, and maybe a better route is to suppress the error on these.
| } | ||
|
|
||
| /** Returns the query whose aggregations will be calculated by this object. */ | ||
| /** @return the query whose aggregations will be calculated by this object. */ |
There was a problem hiding this comment.
The sentence starts after the @return annotation, so make the first letter a capital. Please do this for other texts as well.
| /** @return the query whose aggregations will be calculated by this object. */ | |
| /** @return The query whose aggregations will be calculated by this object. */ |
| private final int failedAttempts; | ||
|
|
||
| /** | ||
| * Constructs a new BulkWriterException with the specified parameters. |
There was a problem hiding this comment.
| * Constructs a new BulkWriterException with the specified parameters. | |
| * Constructs a new BulkWriterException. |
| .setExecutor(null); | ||
| } | ||
|
|
||
| /** @return a new Builder instance. */ |
There was a problem hiding this comment.
| /** @return a new Builder instance. */ | |
| /** @return A new Builder instance. */ |
| /** | ||
| * @param <A> The type of keys in the sorted map. | ||
| * @param <B> The type of keys in the sorted map. | ||
| * @param <C> The type of keys in the sorted map. |
There was a problem hiding this comment.
| * @param <C> The type of keys in the sorted map. | |
| * @param <C> The type of values in map. |
| * | ||
| * @param map The map to build the sorted map from. | ||
| * @param comparator The comparator to use for defining the order of keys in the sorted map. | ||
| * @param <K> The type of keys in the original map. |
There was a problem hiding this comment.
| * @param <K> The type of keys in the original map. | |
| * @param <K> The type of keys in the map. |
| * @param map The map to build the sorted map from. | ||
| * @param comparator The comparator to use for defining the order of keys in the sorted map. | ||
| * @param <K> The type of keys in the original map. | ||
| * @param <V> The type of values in the original map. |
There was a problem hiding this comment.
| * @param <V> The type of values in the original map. | |
| * @param <V> The type of values in the map. |
| * @param comparator the comparator to use for defining the order of keys in the sorted map | ||
| * @param keys the array of keys | ||
| * @param values the array of values | ||
| */ |
There was a problem hiding this comment.
This is a private method. Does it need documentation?
|
You want to focus on the "errors: " lines rather than "warnings: ". |
|
Re-opening a new PR which only addresses errors, not warnings. #1353 |
Thank you @suztomo, javadoc test passed after fixing the "errors". |
Adding / updating comments to pass javadoc lint check