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

Documentation Support #125

Closed
JakeWharton opened this issue Dec 9, 2014 · 1 comment · Fixed by #169
Closed

Documentation Support #125

JakeWharton opened this issue Dec 9, 2014 · 1 comment · Fixed by #169
Milestone
JavaPoet 1.0

Comments

@JakeWharton
Copy link
Member

Javadoc on type, field, method. Would be nice to have top-of-file command for license and/or generated warning as well. In its dumbest form this just need to take a string (or aggregate strings).

Interesting things here might be @param support on a ParameterWriter (VariableWriter subclass)? @throws on a ThrowsWriter? @return somewhere?
@JakeWharton JakeWharton added this to the 3.0 milestone Dec 9, 2014
@octylFractal
Copy link
Contributor

Waiting on this one, I need to document my auto-generated code.

swankjesse added a commit that referenced this issue Jan 13, 2015
@swankjesse
Top of file comments. Stream to the filesystem.
cbf6543 
Closes #125
@swankjesse swankjesse mentioned this issue Jan 13, 2015
Merged
swankjesse added a commit that referenced this issue Jan 13, 2015
@swankjesse
Top of file comments. Stream to the filesystem.
02bd3a1 
Closes #125
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
JavaPoet 1.0
Development

Successfully merging a pull request may close this issue.

Top of file comments. Stream to the filesystem. square/javapoet
2 participants
@JakeWharton @octylFractal