Skip to content

Commit 1f26c12

Browse files
committed
Use JDoc and inherit doc
1 parent 542867f commit 1f26c12

1 file changed

Lines changed: 14 additions & 5 deletions

File tree

extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1377,11 +1377,20 @@ private ItagInfo buildAndAddItagInfoToList(
13771377
return itagInfo;
13781378
}
13791379

1380-
// Warning: When using this method be aware that the YouTube API very rarely returns framesets,
1381-
// that are slightly too small e.g. framesPerPageX = 5, frameWidth = 160, but the url contains
1382-
// a storyboard that is only 795 pixels wide (5*160 > 795). You will need to handle this
1383-
// "manually" to avoid errors.
1384-
// For further reference see: https://github.com/TeamNewPipe/NewPipe/pull/11596
1380+
1381+
/**
1382+
* {@inheritDoc}
1383+
* Should return a list of Frameset object that contains preview of stream frames
1384+
*
1385+
* <p><b>Warning:</b> When using this method be aware
1386+
* that the YouTube API very rarely returns framesets,
1387+
* that are slightly too small e.g. framesPerPageX = 5, frameWidth = 160, but the url contains
1388+
* a storyboard that is only 795 pixels wide (5*160 > 795). You will need to handle this
1389+
* "manually" to avoid errors.</p>
1390+
*
1391+
* @see <a href="https://github.com/TeamNewPipe/NewPipe/pull/11596">
1392+
* TeamNewPipe/NewPipe#11596</a>
1393+
*/
13851394
@Nonnull
13861395
@Override
13871396
public List<Frameset> getFrames() throws ExtractionException {

0 commit comments

Comments
 (0)