Skip to content

Commit dd95105

Browse files
committed
minor refactor: remove warning
1 parent 25280eb commit dd95105

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyRootDoc.java

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,12 +110,20 @@ public void setDescription(String description) {
110110
this.description = description;
111111
}
112112

113-
/** {@inheritDoc} */
113+
/**
114+
* Returns the root description text.
115+
*
116+
* @return the configured description
117+
*/
114118
public String description() {
115119
return description;
116120
}
117121

118-
/** {@inheritDoc} */
122+
/**
123+
* Returns the first-sentence summary derived from {@link #description()}.
124+
*
125+
* @return the first-sentence summary
126+
*/
119127
public String summary() {
120128
return SimpleGroovyDoc.calculateFirstSentence(description);
121129
}

0 commit comments

Comments
 (0)