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

Support JavaDoc for generated interfaces #3

Open
erikhofer opened this issue Jan 26, 2017 · 0 comments
Open

Support JavaDoc for generated interfaces #3

erikhofer opened this issue Jan 26, 2017 · 0 comments
Assignees
@erikhofer
Labels
enhancement

Comments

@erikhofer
Copy link
Member

It should be possible to document the generated interfaces.

The easiest way is to copy the JavaDoc commenst from the annotated class. It would, however, be good to be able to document the implementation as well. A way to achieve this is by using @implSpec and @implNote and not copying them to the interface.
@erikhofer erikhofer self-assigned this Jan 26, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@erikhofer erikhofer

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@erikhofer