Skip to content

Commit fdebf3c

Browse files
committed
Added javadoc warnings
1 parent 6860543 commit fdebf3c

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

extractor/src/main/java/org/schabi/newpipe/extractor/comments/CommentsExtractor.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ public CommentsExtractor(final StreamingService service, final ListLinkHandler u
1313
super(service, uiHandler);
1414
}
1515

16+
/**
17+
* @apiNote Warning: This method is experimental and may get removed in a future release.
18+
* @return <code>true</code> if the comments are disabled otherwise <code>false</code> (default)
19+
*/
1620
public boolean isCommentsDisabled() {
1721
return false;
1822
}

extractor/src/main/java/org/schabi/newpipe/extractor/comments/CommentsInfo.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,19 @@ public void setCommentsExtractor(final CommentsExtractor commentsExtractor) {
8181
this.commentsExtractor = commentsExtractor;
8282
}
8383

84+
/**
85+
* @apiNote Warning: This method is experimental and may get removed in a future release.
86+
* @return <code>true</code> if the comments are disabled otherwise <code>false</code> (default)
87+
* @see CommentsExtractor#isCommentsDisabled()
88+
*/
8489
public boolean isCommentsDisabled() {
8590
return commentsDisabled;
8691
}
8792

93+
/**
94+
* @apiNote Warning: This method is experimental and may get removed in a future release.
95+
* @param commentsDisabled <code>true</code> if the comments are disabled otherwise <code>false</code>
96+
*/
8897
public void setCommentsDisabled(final boolean commentsDisabled) {
8998
this.commentsDisabled = commentsDisabled;
9099
}

0 commit comments

Comments
 (0)