question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

InvalidParam warning on Javadoc for Java record components

See original GitHub issue

Description 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:open
  • Created 2 years ago
  • Reactions:9
  • Comments:8 (3 by maintainers)

github_iconTop GitHub Comments

4reactions
rickiecommented, Sep 8, 2022
2reactions
rickiecommented, Sep 6, 2022

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.

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found