The Method summary block of the groovydoc pages contains a sentence describing the method.
However, if the javadoc looks like (taken from StreamingJsonBuilder.groovy):
Then the summary text becomes:
In this case, it is only confusing (as the assert is missed off the end, but in other cases, it could result in invalid code being shown in the summary.
The attached patch adds another replaceAll to the calculateFirstSentence method of SimpleGroovyDoc.java which trims the javadoc as soon as an HTML tag is encountered as the first thing on a new line in the javadoc.
The summary text for this same method then becomes simply:
|Field||Original Value||New Value|
|Assignee||Guillaume Laforge [ guillaume ]|
|Status||Open [ 1 ]||Resolved [ 5 ]|
|Fix Version/s||1.8.3 [ 17657 ]|
|Fix Version/s||1.9-beta-4 [ 17656 ]|
|Resolution||Fixed [ 1 ]|
|Status||Resolved [ 5 ]||Closed [ 6 ]|