[GRADLE-339] GroovyDoc should be generated for API, not just JavaDoc Created: 28/Dec/08 Updated: 04/Jan/13 Resolved: 05/Jan/09 |
|
| Status: | Resolved |
| Project: | Gradle |
| Affects Version/s: | 0.5 |
| Fix Version/s: | None |
| Type: | Improvement | ||
| Reporter: | Hamlet D'Arcy | Assignee: | Hans Dockter |
| Resolution: | Won't Fix | Votes: | 0 |
| Description |
|
The online API documentation looks to be generated with Javadoc. However, none of the GroovyDoc is generated. This means objects like CompilerOptions have no API documentation. I think GroovyDoc can generate this for you, but I'm not sure how it integrates with Javadoc. I have no patch but I'll look into it a little. |
| Comments |
| Comment by Hans Dockter [ 05/Jan/09 ] |
|
We generate the Groovydoc locally, but it is not worth uploading. Inheritance relations are not shown. You can't add groovydoc to fields. I think this would confuse people more than irt helps them. I have filed a couple of Jira's for this. Paul King is working on groovydoc right now. So with 1.6 the situation might change. On the other hand we want to have eventually a pure Java core. Then this won't be much of an issue anyway. |
| Comment by Russel Winder [ 01/Mar/11 ] |
|
After two years has the situation changed? |
| Comment by Adam Murdoch [ 01/Mar/11 ] |
|
Not really. The groovydoc is now published along with the javadoc: http://gradle.org/1.0-milestone-1/docs/groovydoc/ The groovydoc tool is still pretty broken, so we've instead been growing the DSL documentation as a replacement: http://gradle.org/1.0-milestone-1/docs/dsl/. This will eventually document the entire DSL. |