[GRADLE-375] Include groovy/gradle examples within the Javadocs to show how classes correspond to build.gradle syntax Created: 26/Jan/09  Updated: 01/May/13  Resolved: 01/May/13

Status: Resolved
Project: Gradle
Affects Version/s: None
Fix Version/s: None

Type: Improvement
Reporter: Jon Cox Assignee: Unassigned
Resolution: Fixed Votes: 0


 Description   

When you're learning Gradle (and perhaps Groovy at the same time),
the sheer amount of overloading, Expando-magic, binding magic,
and so forth can get to be a bit much.

What might make things easier is to have more references to
snippets of build.gradle code in the Javadocs that illustrate
how the classes get used. Also, it would be nice if in more
places in the user manual, references would be made to
the corresponding API class(es).

As an example of the latter, consider 'createTask'.
If the user manual showed all the overloaded forms,
and commented the usage a bit more, then a comment
like the following one would make more sense to a reader
who's just on page 11 (Section 4.2):

dir("/somepath") is a convenience method for createTask("somepath", type: Directory)


 Comments   
Comment by Hans Dockter [ 08/Feb/09 ]

That would be very nice and our Javadoc should eventually be that good.

Comment by Adam Murdoch [ 01/May/13 ]

We've been adding examples to the Javadocs for a number of releases now, so I'm marking this as 'fixed'. Over time the number of examples will grow. Feel free to suggest particular examples that you feel are missing.

Generated at Wed Jun 30 11:28:32 CDT 2021 using Jira 8.4.2#804003-sha1:d21414fc212e3af190e92c2d2ac41299b89402cf.