[GROOVY-3958] Documentation for Collection Jdk Methods

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 1.7.1
• Component/s: groovy-jdk
• Assignee: Paul King
• Reporter: malbery
• Created: 27/Dec/09 15:37
• Updated: 07/Apr/15 19:12
• Resolved: 28/Dec/09 16:47

Description

Added groovy assertions to Javadocs for Collection methods, e.g.:

    /**
     * Sums the items in a collection.  This is equivalent to invoking the
     * "plus" method on all items in the collection.
     * <pre class="groovyTestCase">assert 1+2+3+4 == [1,2,3,4].sum()</pre>
     *
     * @param self Collection of values to add together
     * @return The sum of all of the items
     * @since 1.0
     */

The patch includes a TestSuite that will execute the code inside the pre tag to ensure that the assertions hold.

Issue Links

• supercedes: GROOVY-3913 Automated testing of Groovy assertions in javadoc comments