Use JDoc and inherit doc

This commit is contained in:
TobiGr 2024-10-27 09:34:39 +01:00
parent 542867ff4d
commit 1f26c12098
1 changed files with 14 additions and 5 deletions

View File

@ -1377,11 +1377,20 @@ public class YoutubeStreamExtractor extends StreamExtractor {
return itagInfo; return itagInfo;
} }
// Warning: When using this method be aware that the YouTube API very rarely returns framesets,
// that are slightly too small e.g. framesPerPageX = 5, frameWidth = 160, but the url contains /**
// a storyboard that is only 795 pixels wide (5*160 > 795). You will need to handle this * {@inheritDoc}
// "manually" to avoid errors. * Should return a list of Frameset object that contains preview of stream frames
// For further reference see: https://github.com/TeamNewPipe/NewPipe/pull/11596 *
* <p><b>Warning:</b> When using this method be aware
* that the YouTube API very rarely returns framesets,
* that are slightly too small e.g. framesPerPageX = 5, frameWidth = 160, but the url contains
* a storyboard that is only 795 pixels wide (5*160 > 795). You will need to handle this
* "manually" to avoid errors.</p>
*
* @see <a href="https://github.com/TeamNewPipe/NewPipe/pull/11596">
* TeamNewPipe/NewPipe#11596</a>
*/
@Nonnull @Nonnull
@Override @Override
public List<Frameset> getFrames() throws ExtractionException { public List<Frameset> getFrames() throws ExtractionException {