You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@groovy.apache.org by pa...@apache.org on 2026/04/28 10:26:55 UTC
(groovy) 05/05: minor refactor: remove warning
This is an automated email from the ASF dual-hosted git repository.
paulk-asert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/groovy.git
commit dd95105aa94c4b4e5fcb406bb5c53b98ed145d5e
Author: Paul King <pa...@asert.com.au>
AuthorDate: Tue Apr 28 20:25:09 2026 +1000
minor refactor: remove warning
---
.../codehaus/groovy/tools/groovydoc/SimpleGroovyRootDoc.java | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyRootDoc.java b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyRootDoc.java
index a727a51ea1..78d8d11bef 100644
--- a/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyRootDoc.java
+++ b/subprojects/groovy-groovydoc/src/main/java/org/codehaus/groovy/tools/groovydoc/SimpleGroovyRootDoc.java
@@ -110,12 +110,20 @@ public class SimpleGroovyRootDoc extends SimpleGroovyDoc implements GroovyRootDo
this.description = description;
}
- /** {@inheritDoc} */
+ /**
+ * Returns the root description text.
+ *
+ * @return the configured description
+ */
public String description() {
return description;
}
- /** {@inheritDoc} */
+ /**
+ * Returns the first-sentence summary derived from {@link #description()}.
+ *
+ * @return the first-sentence summary
+ */
public String summary() {
return SimpleGroovyDoc.calculateFirstSentence(description);
}