You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/** * Interface for objects that have a name. * * @apiNote you must implement one of {@link #getName()} or {@link #name()}. */interfaceNameable {}
[ant:checkstyle] [ERROR] /home/xeno/IdeaProjects/spring-app-commons/module/model/src/main/java/com/xenoterracide/model/Nameable.java:11:4: Unknown tag 'apiNote'. [JavadocType]
Is your feature request related to a problem? Please describe.
Describe the solution you'd like
Although the tags mentioned above are used by java itself, they aren't enabled by default, and you have to pass options to javadoc to use them. note: the weird quoting mentioned in the doc appears to be a shell escape as it's completely irrelevant in gradle
it might be reasonable to consider adding apiNote,apiSpec,implNote,implSpec as either defaults for this new property, or just have them be recognized without that. I'm indifferent. I just don't like the idea that by allowing unknown tags, it means anything. Meaning typos won't be caught, or other junk.
The text was updated successfully, but these errors were encountered:
In the meantime you can suppress violation as done in #14618 (comment).
It is highly likely that property would not be added until the check is redesigned to be AST based,
and in my opinion it shouldn't be added until the redesign is done because the current implementation is not reliable to detect various tag formats that is used for such cases.
I just don't like the idea that by allowing unknown tags, it means anything.
Since, java 8 there are new javadoc tags, but you can also add arbitrary ones
https://nipafx.dev/javadoc-tags-apiNote-implSpec-implNote/
How it works Now:
Is your feature request related to a problem? Please describe.
Describe the solution you'd like
Although the tags mentioned above are used by java itself, they aren't enabled by default, and you have to pass options to javadoc to use them. note: the weird quoting mentioned in the doc appears to be a shell escape as it's completely irrelevant in gradle
I think the best option is to introduce a property of "additional tags"
Additional context
it might be reasonable to consider adding
apiNote,apiSpec,implNote,implSpec
as either defaults for this new property, or just have them be recognized without that. I'm indifferent. I just don't like the idea that by allowing unknown tags, it means anything. Meaning typos won't be caught, or other junk.The text was updated successfully, but these errors were encountered: