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.

Sign up for GitHub

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

Jump to bottom

[SHIRO-216] Add @Documented to Shiro annotations #318

Merged
merged 1 commit into from
Aug 20, 2021
Merged

[SHIRO-216] Add @Documented to Shiro annotations #318

merged 1 commit into from
Aug 20, 2021

Conversation

bdemers
Copy link
Member

@bdemers bdemers commented Aug 18, 2021

Shiro annotations will now be included in generated Javadoc

Fixes: SHIRO-216

@bdemers bdemers requested a review from bmarwell August 18, 2021 21:59
bmarwell
bmarwell approved these changes Aug 19, 2021
View reviewed changes
Copy link
Contributor

@bmarwell bmarwell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@bdemers
Copy link
Member Author

bdemers commented Aug 19, 2021

I think you are right, given that this is an entry point into a code path (when an event is triggered), adding @Documented should help make it more obvious. I'll push a change in a few minutes 😄

@bdemers
Add @documented to Shiro annotations
29056fc 
Shiro annotations will now be included in generated Javadoc

Fixes: SHIRO-216
@bdemers
Copy link
Member Author

bdemers commented Aug 19, 2021

(amended previous commit)

@bmarwell bmarwell merged commit 55deabc into main Aug 20, 2021
@bmarwell bmarwell deleted the SHIRO-216 branch August 20, 2021 07:09
@bmarwell bmarwell changed the title Add @Documented to Shiro annotations [SHIRO-216] Add @Documented to Shiro annotations Aug 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bmarwell bmarwell bmarwell approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bdemers @bmarwell