[SHIRO-216] Add @Documented to Shiro annotations #318
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bmarwell
approved these changes
Aug 19, 2021
Contributor
bmarwell
left a comment
bmarwell
left a comment
There was a problem hiding this comment.
Question: No sure about how much we want to document, but there is also:
org.apache.shiro.event.Subscribe.
Do we need to take care of this annotation as well?
Member
Author
|
I think you are right, given that this is an entry point into a code path (when an event is triggered), adding |
Shiro annotations will now be included in generated Javadoc Fixes: SHIRO-216
Member
Author
|
(amended previous commit) |
bmarwell
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Shiro annotations will now be included in generated Javadoc
Fixes: SHIRO-216