From ecb8ad85a177992c10e65ca4708c76523d0bb26c Mon Sep 17 00:00:00 2001 From: Vasiliy Date: Wed, 11 Sep 2019 19:03:53 +0300 Subject: [PATCH] Update comments --- .../java/org/schabi/newpipe/extractor/stream/Frameset.java | 3 +++ .../schabi/newpipe/extractor/stream/StreamExtractor.java | 6 ++++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/stream/Frameset.java b/extractor/src/main/java/org/schabi/newpipe/extractor/stream/Frameset.java index 5543d6fc..2d4010dd 100644 --- a/extractor/src/main/java/org/schabi/newpipe/extractor/stream/Frameset.java +++ b/extractor/src/main/java/org/schabi/newpipe/extractor/stream/Frameset.java @@ -22,6 +22,9 @@ public final class Frameset { this.framesPerPageY = framesPerPageY; } + /** + * @return list of urls to images with frames + */ public List getUrls() { return urls; } diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamExtractor.java index 59a1c158..e3400767 100644 --- a/extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamExtractor.java +++ b/extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamExtractor.java @@ -259,8 +259,10 @@ public abstract class StreamExtractor extends Extractor { public abstract StreamInfoItemsCollector getRelatedStreams() throws IOException, ExtractionException; /** - * Should return a list of frames - * @return + * Should return a list of Frameset object that contains preview of stream frames + * @return list of preview frames or empty list if frames preview is not supported or not found for specified stream + * @throws IOException + * @throws ExtractionException */ @Nonnull public List getFrames() throws IOException, ExtractionException {