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

Feature request: omit deprecated methods/argument signatures from doclet generation #4

Open
kevinstadler opened this issue Aug 17, 2023 · 1 comment

Comments

@kevinstadler
Copy link
Contributor

As the title says: the sound library maintains argument signatures for some methods in its codebase only for backwards compatibility, however they should best be omitted from the online reference, since they would only confuse new users. These methods are already marked as @deprecated in the codebase, so it would be great if the doclet generation could check for such annotations and omit them from the json output.

@kevinstadler
Copy link
Contributor Author

Just realised that it's already possible to exclude methods (and even individual method signatures of an overloaded method) from being added to the doclet using the @nowebref or @notWebref tags, so this should be as easy as adding "deprecated" to this array:

private String[] omitWebTagNames = { "nowebref", "notWebref" };

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant