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
[JavadocType] add additional allowedTags feature #14724
Comments
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,
I agree with this. #14618 (comment) |
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: