From 7c29dbc965576d523ec59cca67ef493635c53667 Mon Sep 17 00:00:00 2001 From: TobiGr Date: Tue, 23 Apr 2024 19:32:57 +0200 Subject: [PATCH] Fix JDoc Add Checkstyle exception for LineLength in JDoc links. See https://github.com/TeamNewPipe/NewPipeExtractor/actions/runs/8804403691/job/24164703883 --- checkstyle/checkstyle.xml | 2 + .../schabi/newpipe/extractor/MediaFormat.java | 2 +- .../ReadyChannelTabListLinkHandler.java | 1 - .../extractors/BandcampExtractorHelper.java | 3 +- .../YoutubeDashManifestCreatorsUtils.java | 11 ++-- .../YoutubeOtfDashManifestCreator.java | 61 +++++++++---------- ...ePostLiveStreamDvrDashManifestCreator.java | 38 ++++++------ ...YoutubeProgressiveDashManifestCreator.java | 39 ++++++------ .../services/youtube/extractors/ItagInfo.java | 4 +- .../extractor/stream/DeliveryMethod.java | 4 +- 10 files changed, 79 insertions(+), 86 deletions(-) diff --git a/checkstyle/checkstyle.xml b/checkstyle/checkstyle.xml index 454595bb4..3b5825a3b 100644 --- a/checkstyle/checkstyle.xml +++ b/checkstyle/checkstyle.xml @@ -38,6 +38,8 @@ + + diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/MediaFormat.java b/extractor/src/main/java/org/schabi/newpipe/extractor/MediaFormat.java index 345f75165..dc31e6f31 100644 --- a/extractor/src/main/java/org/schabi/newpipe/extractor/MediaFormat.java +++ b/extractor/src/main/java/org/schabi/newpipe/extractor/MediaFormat.java @@ -51,7 +51,7 @@ public enum MediaFormat { WEBMA_OPUS(0x200, "WebM Opus", "webm", "audio/webm"), 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"), WAV (0x700, "WAV", "wav", "audio/wav"), diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/linkhandler/ReadyChannelTabListLinkHandler.java b/extractor/src/main/java/org/schabi/newpipe/extractor/linkhandler/ReadyChannelTabListLinkHandler.java index aad50f479..33286c8f7 100644 --- a/extractor/src/main/java/org/schabi/newpipe/extractor/linkhandler/ReadyChannelTabListLinkHandler.java +++ b/extractor/src/main/java/org/schabi/newpipe/extractor/linkhandler/ReadyChannelTabListLinkHandler.java @@ -27,7 +27,6 @@ import java.util.List; * return ((ReadyChannelTabListLinkHandler) linkHandler).getChannelTabExtractor(this); * } * - *

*/ public class ReadyChannelTabListLinkHandler extends ListLinkHandler { diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/bandcamp/extractors/BandcampExtractorHelper.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/bandcamp/extractors/BandcampExtractorHelper.java index e7bbac999..216c3b756 100644 --- a/extractor/src/main/java/org/schabi/newpipe/extractor/services/bandcamp/extractors/BandcampExtractorHelper.java +++ b/extractor/src/main/java/org/schabi/newpipe/extractor/services/bandcamp/extractors/BandcampExtractorHelper.java @@ -111,8 +111,7 @@ public final class BandcampExtractorHelper { /** * Fetch artist details from mobile endpoint. - * + * * More technical info. */ public static JsonObject getArtistDetails(final String id) throws ParsingException { diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubeDashManifestCreatorsUtils.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubeDashManifestCreatorsUtils.java index 33fe3207c..5e0fb6d4c 100644 --- a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubeDashManifestCreatorsUtils.java +++ b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubeDashManifestCreatorsUtils.java @@ -119,7 +119,7 @@ public final class YoutubeDashManifestCreatorsUtils { /** * Generate a {@link Document} with common manifest creator elements added to it. * - *

+ *
* Those are: *

- *

+ * * * @param itagItem the {@link ItagItem} associated to the stream, which must not be null * @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. *

* - *

* It will produce a {@code } element with the following attributes: *

- *

* *

* The {@code } 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. - * - *

This method fetches, for OTF streams and for post-live-DVR streams: + *
+ * This method fetches, for OTF streams and for post-live-DVR streams: *

- *

* * @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 diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubeOtfDashManifestCreator.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubeOtfDashManifestCreator.java index 46e84df1d..27496907c 100644 --- a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubeOtfDashManifestCreator.java +++ b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubeOtfDashManifestCreator.java @@ -53,38 +53,37 @@ public final class YoutubeOtfDashManifestCreator { * livestreams which have just been re-encoded as normal videos. *

* - *

This method needs: - *

- *

+ * This method needs: + * + * + * In order to generate the DASH manifest, this method will: + * * - *

In order to generate the DASH manifest, this method will: - *

- *

* *

* If the duration cannot be extracted, the {@code durationSecondsFallback} value will be used diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubePostLiveStreamDvrDashManifestCreator.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubePostLiveStreamDvrDashManifestCreator.java index 3a5a7dd23..07367e43b 100644 --- a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubePostLiveStreamDvrDashManifestCreator.java +++ b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/dashmanifestcreators/YoutubePostLiveStreamDvrDashManifestCreator.java @@ -56,25 +56,25 @@ public final class YoutubePostLiveStreamDvrDashManifestCreator { * the time) *

* - *

This method needs: - *

- *

+ * This method needs: + * + * * *

In order to generate the DASH manifest, this method will: *