Skip to content

Commit d94a678

Browse files
committed
javadoc fixes
1 parent cc63986 commit d94a678

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

core/src/main/java/org/everit/json/schema/loader/internal/JSONPointer.java

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,11 @@ public static class QueryResult {
4747

4848
/**
4949
* Constructor.
50+
*
51+
* @param containingDocument
52+
* the JSON document which contains the query result.
53+
* @param queryResult
54+
* the JSON object being the result of the query execution.
5055
*/
5156
public QueryResult(final JSONObject containingDocument, final JSONObject queryResult) {
5257
this.containingDocument = Objects.requireNonNull(containingDocument,
@@ -55,14 +60,14 @@ public QueryResult(final JSONObject containingDocument, final JSONObject queryRe
5560
}
5661

5762
/**
58-
* The JSON document which contains the query result.
63+
* @return the JSON document which contains the query result.
5964
*/
6065
public JSONObject getContainingDocument() {
6166
return containingDocument;
6267
}
6368

6469
/**
65-
* The JSON object being the result of the query execution.
70+
* @return the JSON object being the result of the query execution.
6671
*/
6772
public JSONObject getQueryResult() {
6873
return queryResult;
@@ -146,6 +151,7 @@ public JSONPointer(final Supplier<JSONObject> documentProvider, final String fra
146151
*
147152
* @throws IllegalArgumentException
148153
* if the pointer does not start with {@code '#'}.
154+
* @return a DTO containing the query result and the root document containing the query result
149155
*/
150156
public QueryResult query() {
151157
JSONObject document = documentProvider.get();

0 commit comments

Comments
 (0)