Skip to content

Commit 5d4e233

Browse files
Add JavaDocs for getSectionList too
1 parent 1ae8ac8 commit 5d4e233

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/test/java/org/javawebstack/orm/test/shared/verification/QueryVerification.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,13 @@ public String getSection(String topLevelKeyword, int sectionIndex) throws Sectio
111111
}
112112
}
113113

114-
114+
/**
115+
* Retrieve list of all sections prefaced with the specified top level keyword. The list will have the same order
116+
* as the occurrences of each section.
117+
*
118+
* @param topLevelKeyword The top level keyword that prefaces the sections.
119+
* @return The order sensitive list of inner sections.
120+
*/
115121
public List<String> getSectionList(String topLevelKeyword) {
116122
return new QueryStringUtil(this.query.getQueryString().getQuery())
117123
.getTopLevelSectionsByKeyword(topLevelKeyword);

0 commit comments

Comments
 (0)