Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Audit usage of @inheritDoc #424

Open
justinabrahms opened this issue May 7, 2023 · 1 comment
Open

Audit usage of @inheritDoc #424

justinabrahms opened this issue May 7, 2023 · 1 comment
Labels
contribfest A good issue for Contribfest KubeCon EU '24 good first issue Good for newcomers help wanted Extra attention is needed

Comments

@justinabrahms
Copy link
Member

We're using @inheritDoc to avoid writing javadoc, but that's not well founded in some cases. Audit the usage of it and ensure our docs are reasonable.

@toddbaert toddbaert added good first issue Good for newcomers help wanted Extra attention is needed labels May 8, 2023
@toddbaert toddbaert added the contribfest A good issue for Contribfest KubeCon EU '24 label Mar 11, 2024
@ryanprayogo
Copy link
Contributor

The usage of @inheritDoc also causes the maven-javadoc-plugin to fail under Java 21.

[WARNING] Javadoc Warnings
[WARNING] .../java-sdk/src/main/java/dev/openfeature/sdk/BooleanHook.java:4: warning: Tag @inheritDoc cannot be used in class documentation.  It can only be used in the following types of documentation: method.
[WARNING] * {@inheritDoc}
[WARNING] ^
...
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.8.0:jar (attach-javadocs) on project sdk: MavenReportException: Error while generating Javadoc: Project contains Javadoc Warnings -> [Help 1]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribfest A good issue for Contribfest KubeCon EU '24 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants