Added more doc

TeamNewPipe · Jun 19, 2021 · 3b264f3 · 3b264f3
1 parent 0825a1c
commit 3b264f3
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/...va/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeCommentsExtractor.java b/...va/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeCommentsExtractor.java
@@ -43,6 +43,15 @@ public class YoutubeCommentsExtractor extends CommentsExtractor {
     private String ytClientName;
     private String responseBody;
 
+    /**
+     * Caching mechanism and holder of the commentsDisabled value.
+     * <br/>
+     * Initial value = empty -> unknown if comments are disabled or not<br/>
+     * Some method calls {@link YoutubeCommentsExtractor#findInitialCommentsToken()}
+     * -> value is set<br/>
+     * If the method or another one that is depending on disabled comments
+     * is now called again, the method execution can avoid unnecessary calls
+     */
     private Optional<Boolean> optCommentsDisabled = Optional.empty();
 
     public YoutubeCommentsExtractor(