Skip to content

Commit 99340dc

Browse files
committed
Fix javadoc warning
1 parent c8853c8 commit 99340dc

File tree

1 file changed

+3
-0
lines changed
  • therapi-runtime-javadoc/src/main/java/com/github/therapi/runtimejavadoc

1 file changed

+3
-0
lines changed

therapi-runtime-javadoc/src/main/java/com/github/therapi/runtimejavadoc/ClassJavadoc.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ public List<MethodJavadoc> getConstructors() {
6767
/**
6868
* If this class is a record, returns the "@param" tags from the canonical constructor.
6969
* Otherwise, returns an empty list.
70+
*
71+
* @return a non-null (but possibly empty) list of param tags describing the record components,
72+
* in the order the tags appear in the Javadoc.
7073
*/
7174
public List<ParamJavadoc> getRecordComponents() {
7275
return recordComponents;

0 commit comments

Comments
 (0)