Added javadoc warnings

This commit is contained in:
litetex 2021-07-07 20:41:59 +02:00
parent 6860543b07
commit fdebf3c6cd
2 changed files with 13 additions and 0 deletions

View File

@ -13,6 +13,10 @@ public abstract class CommentsExtractor extends ListExtractor<CommentsInfoItem>
super(service, uiHandler); super(service, uiHandler);
} }
/**
* @apiNote Warning: This method is experimental and may get removed in a future release.
* @return <code>true</code> if the comments are disabled otherwise <code>false</code> (default)
*/
public boolean isCommentsDisabled() { public boolean isCommentsDisabled() {
return false; return false;
} }

View File

@ -81,10 +81,19 @@ public class CommentsInfo extends ListInfo<CommentsInfoItem> {
this.commentsExtractor = commentsExtractor; this.commentsExtractor = commentsExtractor;
} }
/**
* @apiNote Warning: This method is experimental and may get removed in a future release.
* @return <code>true</code> if the comments are disabled otherwise <code>false</code> (default)
* @see CommentsExtractor#isCommentsDisabled()
*/
public boolean isCommentsDisabled() { public boolean isCommentsDisabled() {
return commentsDisabled; return commentsDisabled;
} }
/**
* @apiNote Warning: This method is experimental and may get removed in a future release.
* @param commentsDisabled <code>true</code> if the comments are disabled otherwise <code>false</code>
*/
public void setCommentsDisabled(final boolean commentsDisabled) { public void setCommentsDisabled(final boolean commentsDisabled) {
this.commentsDisabled = commentsDisabled; this.commentsDisabled = commentsDisabled;
} }