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

Add/Improve Javadoc for annotatedWith #835

Merged
merged 1 commit into from
Mar 30, 2022

Conversation

rweisleder
Copy link
Contributor

@rweisleder rweisleder commented Mar 17, 2022

This commit also incorporates the changes from #540, that meta-annotated-with predicates and conditions also consider direct annotations.

This commit also incorporates the changes from TNG#540, that meta-annotated-with predicates and conditions also consider direct annotations.

Signed-off-by: Roland Weisleder <roland.weisleder@googlemail.com>
@codecholeric codecholeric force-pushed the javadoc-annotatedWith branch from 21acf81 to 693b187 Compare March 29, 2022 05:44
@codecholeric
Copy link
Collaborator

Thanks a lot for the improvement 😄 I changed two little things:

  1. add a @param annotationTypeName description additionally to @see methodWithClass(Class) that explains that this is the fully qualified class name (because I have seen users struggle with this and using the simple class name)
  2. for the negated explanation for meta-annotated-with I inverted the part in <p>, because I thought it might be misunderstood. E.g.
    The assertion is also successful if members are not directly annotated with the supplied annotation type. -> The assertion also fails if members are directly annotated with the supplied annotation type. Because the former sounds like it might already be a sufficient condition to be not directly annotated with the annotation type, while in fact it has to be neither annotated directly nor meta-annotated.

Anyway, I hope that this additional documentation will help users, in particular with the not obvious part about meta-annotated also matching direct annotations 👍

@rweisleder
Copy link
Contributor Author

LGTM, thanks!

@codecholeric codecholeric merged commit c5a14aa into TNG:main Mar 30, 2022
@rweisleder rweisleder deleted the javadoc-annotatedWith branch March 30, 2022 13:37
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

Successfully merging this pull request may close these issues.

2 participants