Skip to content

Commit 32f1741

Browse files
committed
Add Missing JavaDoc to PagianteResult Fileds
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
1 parent e9976da commit 32f1741

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

src/main/java/io/securecodebox/persistence/defectdojo/model/PaginatedResult.java

+9-3
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@
1818
@Data
1919
public final class PaginatedResult<T extends Model> {
2020
/**
21-
* TODO: What does this count? The number of results in one page or the total number?
21+
* Total number of results
2222
*/
2323
@JsonProperty
2424
private int count;
2525

2626
/**
27-
* TODO: What does this contain? I would expect a number for the next page.
27+
* URL to the result's next page
2828
* <p>
2929
* This is {@code null} if there is no next page.
3030
* </p>
@@ -33,14 +33,20 @@ public final class PaginatedResult<T extends Model> {
3333
private String next;
3434

3535
/**
36-
* TODO: What does this contain? I would expect a number for the previous page.
36+
* URL to the result's previous page
3737
* <p>
3838
* This is {@code null} if there is no previous page.
3939
* </p>
4040
*/
4141
@JsonProperty
4242
private String previous;
4343

44+
/**
45+
* Result for current page
46+
* <p>
47+
* Never {@code null}.
48+
* </p>
49+
*/
4450
@JsonProperty
4551
private List<T> results = new ArrayList<>();
4652
}

0 commit comments

Comments
 (0)