kavin/NewPipeExtractor
1
0
Fork 0
mirror of https://github.com/TeamNewPipe/NewPipeExtractor.git synced 2024-12-13 22:00:32 +05:30
Code Issues Projects Releases Wiki Activity

Merge pull request #1171 from TeamNewPipe/fix/jdoc

Browse Source 
Fix JavaDocs and add Checkstyle exception for line length in JavaDocs' links
This commit is contained in:
Tobi 2024-04-23 21:22:12 +02:00 committed by GitHub
commit ec3e8378c6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 79 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
checkstyle/checkstyle.xml
View File

@ -38,6 +38,8 @@
<module name="LineLength"> <module name="LineLength">
<property name="max" value="100"/> <property name="max" value="100"/>
<property name="fileExtensions" value="java"/> <property name="fileExtensions" value="java"/>
<!-- Also allow links in javadocs to be longer (the default would just cover imports) -->
<property name="ignorePattern" value="^((package|import) .*)|( *\* (@see )?&lt;a href ?\= ?&quot;.*&quot;&gt;)$"/>
</module> </module>
<!-- Checks for whitespace --> <!-- Checks for whitespace -->

2
extractor/src/main/java/org/schabi/newpipe/extractor/MediaFormat.java
View File

@ -51,7 +51,7 @@ public enum MediaFormat {
WEBMA_OPUS(0x200, "WebM Opus", "webm", "audio/webm"), WEBMA_OPUS(0x200, "WebM Opus", "webm", "audio/webm"),
AIFF (0x600, "AIFF", "aiff", "audio/aiff"), AIFF (0x600, "AIFF", "aiff", "audio/aiff"),
/** /**
* Same as {@link MediaFormat.AIFF}, just with the shorter suffix/file extension * Same as {@link MediaFormat#AIFF}, just with the shorter suffix/file extension
*/ */
AIF (0x600, "AIFF", "aif", "audio/aiff"), AIF (0x600, "AIFF", "aif", "audio/aiff"),
WAV (0x700, "WAV", "wav", "audio/wav"), WAV (0x700, "WAV", "wav", "audio/wav"),

1
extractor/src/main/java/org/schabi/newpipe/extractor/linkhandler/ReadyChannelTabListLinkHandler.java
View File

@ -27,7 +27,6 @@ import java.util.List;
* return ((ReadyChannelTabListLinkHandler) linkHandler).getChannelTabExtractor(this); * return ((ReadyChannelTabListLinkHandler) linkHandler).getChannelTabExtractor(this);
* } * }
* </pre> * </pre>
* </p>
*/ */
public class ReadyChannelTabListLinkHandler extends ListLinkHandler { public class ReadyChannelTabListLinkHandler extends ListLinkHandler {

3
extractor/src/main/java/org/schabi/newpipe/extractor/services/bandcamp/extractors/BandcampExtractorHelper.java
View File

@ -111,8 +111,7 @@ public final class BandcampExtractorHelper {
/** /**
* Fetch artist details from mobile endpoint. * Fetch artist details from mobile endpoint.
* <a href="https://notabug.org/fynngodau/bandcampDirect/wiki/ * <a href="https://notabug.org/fynngodau/bandcampDirect/wiki/rewindBandcamp+%E2%80%93+Fetching+artist+details">
* rewindBandcamp+%E2%80%93+Fetching+artist+details">
* More technical info.</a> * More technical info.</a>
*/ */
public static JsonObject getArtistDetails(final String id) throws ParsingException { public static JsonObject getArtistDetails(final String id) throws ParsingException {

11
extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubeDashManifestCreatorsUtils.java
View File

@ -119,7 +119,7 @@ public final class YoutubeDashManifestCreatorsUtils {
/** /**
* Generate a {@link Document} with common manifest creator elements added to it. * Generate a {@link Document} with common manifest creator elements added to it.
* *
* <p> * <br>
* Those are: * Those are:
* <ul> * <ul>
* <li>{@code MPD} (using {@link #generateDocumentAndMpdElement(long)});</li> * <li>{@code MPD} (using {@link #generateDocumentAndMpdElement(long)});</li>
@ -132,7 +132,7 @@ public final class YoutubeDashManifestCreatorsUtils {
* <li>and, for audio streams, {@code AudioChannelConfiguration} (using * <li>and, for audio streams, {@code AudioChannelConfiguration} (using
* {@link #generateAudioChannelConfigurationElement(Document, ItagItem)}).</li> * {@link #generateAudioChannelConfigurationElement(Document, ItagItem)}).</li>
* </ul> * </ul>
* </p> *
* *
* @param itagItem the {@link ItagItem} associated to the stream, which must not be null * @param itagItem the {@link ItagItem} associated to the stream, which must not be null
* @param streamDuration the duration of the stream, in milliseconds * @param streamDuration the duration of the stream, in milliseconds
@ -494,7 +494,6 @@ public final class YoutubeDashManifestCreatorsUtils {
* This method is only used when generating DASH manifests from OTF and post-live-DVR streams. * This method is only used when generating DASH manifests from OTF and post-live-DVR streams.
* </p> * </p>
* *
* <p>
* It will produce a {@code <SegmentTemplate>} element with the following attributes: * It will produce a {@code <SegmentTemplate>} element with the following attributes:
* <ul> * <ul>
* <li>{@code startNumber}, which takes the value {@code 0} for post-live-DVR streams and * <li>{@code startNumber}, which takes the value {@code 0} for post-live-DVR streams and
@ -505,7 +504,6 @@ public final class YoutubeDashManifestCreatorsUtils {
* <li>{@code initialization} (only for OTF streams), which is the base URL of the stream * <li>{@code initialization} (only for OTF streams), which is the base URL of the stream
* on which is appended {@link #SQ_0}.</li> * on which is appended {@link #SQ_0}.</li>
* </ul> * </ul>
* </p>
* *
* <p> * <p>
* The {@code <Representation>} element needs to be generated before this element with * The {@code <Representation>} element needs to be generated before this element with
@ -578,8 +576,8 @@ public final class YoutubeDashManifestCreatorsUtils {
/** /**
* Get the "initialization" {@link Response response} of a stream. * Get the "initialization" {@link Response response} of a stream.
* * <br>
* <p>This method fetches, for OTF streams and for post-live-DVR streams: * This method fetches, for OTF streams and for post-live-DVR streams:
* <ul> * <ul>
* <li>the base URL of the stream, to which are appended {@link #SQ_0} and * <li>the base URL of the stream, to which are appended {@link #SQ_0} and
* {@link #RN_0} parameters, with a {@code GET} request for streaming URLs from HTML5 * {@link #RN_0} parameters, with a {@code GET} request for streaming URLs from HTML5
@ -588,7 +586,6 @@ public final class YoutubeDashManifestCreatorsUtils {
* <li>for streaming URLs from HTML5 clients, the {@link #ALR_YES} param is also added. * <li>for streaming URLs from HTML5 clients, the {@link #ALR_YES} param is also added.
* </li> * </li>
* </ul> * </ul>
* </p>
* *
* @param baseStreamingUrl the base URL of the stream, which must not be null * @param baseStreamingUrl the base URL of the stream, which must not be null
* @param itagItem the {@link ItagItem} of stream, which must not be null * @param itagItem the {@link ItagItem} of stream, which must not be null

61
extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubeOtfDashManifestCreator.java
View File

@ -53,38 +53,37 @@ public final class YoutubeOtfDashManifestCreator {
* livestreams which have just been re-encoded as normal videos. * livestreams which have just been re-encoded as normal videos.
* </p> * </p>
* *
* <p>This method needs: * This method needs:
* <ul> * <ul>
* <li>the base URL of the stream (which, if you try to access to it, returns HTTP * <li>the base URL of the stream (which, if you try to access to it, returns HTTP
* status code 404 after redirects, and if the URL is valid);</li> * status code 404 after redirects, and if the URL is valid);</li>
* <li>an {@link ItagItem}, which needs to contain the following information: * <li>an {@link ItagItem}, which needs to contain the following information:
* <ul> * <ul>
* <li>its type (see {@link ItagItem.ItagType}), to identify if the content is * <li>its type (see {@link ItagItem.ItagType}), to identify if the content is
* an audio or a video stream;</li> * an audio or a video stream;</li>
* <li>its bitrate;</li> * <li>its bitrate;</li>
* <li>its mime type;</li> * <li>its mime type;</li>
* <li>its codec(s);</li> * <li>its codec(s);</li>
* <li>for an audio stream: its audio channels;</li> * <li>for an audio stream: its audio channels;</li>
* <li>for a video stream: its width and height.</li> * <li>for a video stream: its width and height.</li>
* </ul> * </ul>
* </li> * </li>
* <li>the duration of the video, which will be used if the duration could not be * <li>the duration of the video, which will be used if the duration could not be
* parsed from the first sequence of the stream.</li> * parsed from the first sequence of the stream.</li>
* </ul> * </ul>
* </p> *
* In order to generate the DASH manifest, this method will:
* <ul>
* <li>request the first sequence of the stream (the base URL on which the first
* sequence parameter is appended (see {@link YoutubeDashManifestCreatorsUtils#SQ_0}))
* with a {@code POST} or {@code GET} request (depending of the client on which the
* streaming URL comes from is a mobile one ({@code POST}) or not ({@code GET}));</li>
* <li>follow its redirection(s), if any;</li>
* <li>save the last URL, remove the first sequence parameter;</li>
* <li>use the information provided in the {@link ItagItem} to generate all
* elements of the DASH manifest.</li>
* </ul>
* *
* <p>In order to generate the DASH manifest, this method will:
* <ul>
* <li>request the first sequence of the stream (the base URL on which the first
* sequence parameter is appended (see {@link YoutubeDashManifestCreatorsUtils#SQ_0}))
* with a {@code POST} or {@code GET} request (depending of the client on which the
* streaming URL comes from is a mobile one ({@code POST}) or not ({@code GET}));</li>
* <li>follow its redirection(s), if any;</li>
* <li>save the last URL, remove the first sequence parameter;</li>
* <li>use the information provided in the {@link ItagItem} to generate all
* elements of the DASH manifest.</li>
* </ul>
* </p>
* *
* <p> * <p>
* If the duration cannot be extracted, the {@code durationSecondsFallback} value will be used * If the duration cannot be extracted, the {@code durationSecondsFallback} value will be used

38
extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubePostLiveStreamDvrDashManifestCreator.java
View File

@ -56,25 +56,25 @@ public final class YoutubePostLiveStreamDvrDashManifestCreator {
* the time) * the time)
* </p> * </p>
* *
* <p>This method needs: * This method needs:
* <ul> * <ul>
* <li>the base URL of the stream (which, if you try to access to it, returns HTTP * <li>the base URL of the stream (which, if you try to access to it, returns HTTP
* status code 404 after redirects, and if the URL is valid);</li> * status code 404 after redirects, and if the URL is valid);</li>
* <li>an {@link ItagItem}, which needs to contain the following information: * <li>an {@link ItagItem}, which needs to contain the following information:
* <ul> * <ul>
* <li>its type (see {@link ItagItem.ItagType}), to identify if the content is * <li>its type (see {@link ItagItem.ItagType}), to identify if the content is
* an audio or a video stream;</li> * an audio or a video stream;</li>
* <li>its bitrate;</li> * <li>its bitrate;</li>
* <li>its mime type;</li> * <li>its mime type;</li>
* <li>its codec(s);</li> * <li>its codec(s);</li>
* <li>for an audio stream: its audio channels;</li> * <li>for an audio stream: its audio channels;</li>
* <li>for a video stream: its width and height.</li> * <li>for a video stream: its width and height.</li>
* </ul> * </ul>
* </li> * </li>
* <li>the duration of the video, which will be used if the duration could not be * <li>the duration of the video, which will be used if the duration could not be
* parsed from the first sequence of the stream.</li> * parsed from the first sequence of the stream.</li>
* </ul> * </ul>
* </p> *
* *
* <p>In order to generate the DASH manifest, this method will: * <p>In order to generate the DASH manifest, this method will:
* <ul> * <ul>

39
extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubeProgressiveDashManifestCreator.java
View File

@ -47,26 +47,25 @@ public final class YoutubeProgressiveDashManifestCreator {
* YouTube partner, and on videos with a large number of views. * YouTube partner, and on videos with a large number of views.
* </p> * </p>
* *
* <p>This method needs: * This method needs:
* <ul> * <ul>
* <li>the base URL of the stream (which, if you try to access to it, returns the whole * <li>the base URL of the stream (which, if you try to access to it, returns the whole
* stream, after redirects, and if the URL is valid);</li> * stream, after redirects, and if the URL is valid);</li>
* <li>an {@link ItagItem}, which needs to contain the following information: * <li>an {@link ItagItem}, which needs to contain the following information:
* <ul> * <ul>
* <li>its type (see {@link ItagItem.ItagType}), to identify if the content is * <li>its type (see {@link ItagItem.ItagType}), to identify if the content is
* an audio or a video stream;</li> * an audio or a video stream;</li>
* <li>its bitrate;</li> * <li>its bitrate;</li>
* <li>its mime type;</li> * <li>its mime type;</li>
* <li>its codec(s);</li> * <li>its codec(s);</li>
* <li>for an audio stream: its audio channels;</li> * <li>for an audio stream: its audio channels;</li>
* <li>for a video stream: its width and height.</li> * <li>for a video stream: its width and height.</li>
* </ul> * </ul>
* </li> * </li>
* <li>the duration of the video (parameter {@code durationSecondsFallback}), which * <li>the duration of the video (parameter {@code durationSecondsFallback}), which
* will be used as the stream duration if the duration could not be parsed from the * will be used as the stream duration if the duration could not be parsed from the
* {@link ItagItem}.</li> * {@link ItagItem}.</li>
* </ul> * </ul>
* </p>
* *
* @param progressiveStreamingBaseUrl the base URL of the progressive stream, which must not be * @param progressiveStreamingBaseUrl the base URL of the progressive stream, which must not be
* null * null

4
extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/ItagInfo.java
View File

@ -8,15 +8,13 @@ import java.io.Serializable;
/** /**
* Class to build easier {@link org.schabi.newpipe.extractor.stream.Stream}s for * Class to build easier {@link org.schabi.newpipe.extractor.stream.Stream}s for
* {@link YoutubeStreamExtractor}. * {@link YoutubeStreamExtractor}.
* * <br>
* <p>
* It stores, per stream: * It stores, per stream:
* <ul> * <ul>
* <li>its content (the URL/the base URL of streams);</li> * <li>its content (the URL/the base URL of streams);</li>
* <li>whether its content is the URL the content itself or the base URL;</li> * <li>whether its content is the URL the content itself or the base URL;</li>
* <li>its associated {@link ItagItem}.</li> * <li>its associated {@link ItagItem}.</li>
* </ul> * </ul>
* </p>
*/ */
final class ItagInfo implements Serializable { final class ItagInfo implements Serializable {
@Nonnull @Nonnull

4
extractor/src/main/java/org/schabi/newpipe/extractor/stream/DeliveryMethod.java
View File

@ -34,8 +34,8 @@ public enum DeliveryMethod {
/** /**
* Used for {@link Stream}s served using the SmoothStreaming adaptive streaming method. * Used for {@link Stream}s served using the SmoothStreaming adaptive streaming method.
* *
* @see <a href="https://en.wikipedia.org/wiki/Adaptive_bitrate_streaming * @see <a href="https://en.wikipedia.org/wiki/Adaptive_bitrate_streaming#Microsoft_Smooth_Streaming_(MSS)">
* #Microsoft_Smooth_Streaming_(MSS)">Wikipedia's page about adaptive bitrate streaming, * Wikipedia's page about adaptive bitrate streaming,
* section <i>Microsoft Smooth Streaming (MSS)</i></a> for more information about the * section <i>Microsoft Smooth Streaming (MSS)</i></a> for more information about the
* SmoothStreaming delivery method * SmoothStreaming delivery method
*/ */