InvalidParam warning on Javadoc for Java record components
See original GitHub issueDescription of the problem / feature request:
Javadoc on Java record components are @param
tags on the record itself. It’s also possible to override the accessor methods, but that shouldn’t be necessary. error-prone produces an InvalidParam
warning here though, as it doesn’t seem to understand the Java record syntax.
Bugs: what’s the simplest, easiest way to reproduce this bug? Please provide a minimal example if possible.
/**
* Example record.
* @param name Name of the example record.
*/
public record ExampleRecord(String name) {
}
What version of Error Prone are you using?
2.6.0
Issue Analytics
- State:
- Created 2 years ago
- Reactions:9
- Comments:8 (3 by maintainers)
Top Results From Across the Web
InvalidParam warning on Javadoc for Java record components -
Description of the problem / feature request: Javadoc on Java record components are @param tags on the record itself.
Read more >How to JavaDoc a record without warnings from -Xdoclint?
1 Answer 1 ... Since the Javadoc example for records in the OpenJDK repository gives the same warning, this is certainly a bug....
Read more >Javadoc @param does not work for Java Records
Javadoc @param does not work for Java Records ... seems to imply that we should be able to document Java Record parameters as...
Read more >False positive: UnusedVariable for record components that ...
A false positive for UnusedVariable is reported for all record components that are only read through methods.
Read more >jdk8/jdk8/langtools: 467e4d9281bc - Java.net
+ * + * @param node the XML element that specifies which components to document + ... TODO: maybe want to record starting...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@bkrieger Opened https://github.com/google/error-prone/pull/3437 which contains a fix 😄.
We have a process where we first review and verify the code in our own fork. Once we are satisfied with the quality we open a PR upstream.
In other words, yes, we plan to open a PR for this in the main repository.