Add more documentation

Author: TobiGr

app/src/main/java/org/schabi/newpipe/streams/Mp4FromDashWriter.java

@@ -783,7 +783,7 @@ private void makeTrak(final int index, final long duration, final int defaultMed
         final int mediaTime;
 
         if (tracks[index].trak.edstElst == null) {
-            // is a audio track ¿is edst/elst optional for audio tracks?
+            // is a audio track; is edst/elst optional for audio tracks?
             mediaTime = 0x00; // ffmpeg set this value as zero, instead of defaultMediaTime
             bMediaRate = 0x00010000;
         } else {
@@ -891,28 +891,35 @@ private int makeSbgp() throws IOException {
         return offset + 0x14;
     }
 
+    /**
+     * Creates a Sample Group Description Box.
+     *
+     * <p>
+     * What does it do?
+     * <br>
+     * The table inside of this box gives information about the
+     * characteristics of sample groups. The descriptive information is any other
+     * information needed to define or characterize the sample group.
+     * </p>
+     *
+     * <p>
+     * ¿is replicable this box?
+     * <br>
+     * NO due lacks of documentation about this box but...
+     * most of m4a encoders and ffmpeg uses this box with dummy values (same values)
+     * </p>
+     *
+     * @return byte array with the 'sgpd' box
+     */
     private byte[] makeSgpd() {
-        /*
-         * Sample Group Description Box
-         *
-         * ¿whats does?
-         * the table inside of this box gives information about the
-         * characteristics of sample groups. The descriptive information is any other
-         * information needed to define or characterize the sample group.
-         *
-         * ¿is replicable this box?
-         * NO due lacks of documentation about this box but...
-         * most of m4a encoders and ffmpeg uses this box with dummy values (same values)
-         */
-
         final ByteBuffer buffer = ByteBuffer.wrap(new byte[] {
                 0x00, 0x00, 0x00, 0x1A, // box size
                 0x73, 0x67, 0x70, 0x64, // "sgpd"
                 0x01, 0x00, 0x00, 0x00, // box flags (unknown flag sets)
-                0x72, 0x6F, 0x6C, 0x6C, // ¿¿group type??
-                0x00, 0x00, 0x00, 0x02, // ¿¿??
-                0x00, 0x00, 0x00, 0x01, // ¿¿??
-                (byte) 0xFF, (byte) 0xFF // ¿¿??
+                0x72, 0x6F, 0x6C, 0x6C, // group type??
+                0x00, 0x00, 0x00, 0x02, // ??
+                0x00, 0x00, 0x00, 0x01, // ??
+                (byte) 0xFF, (byte) 0xFF // ??
         });
 
         return buffer.array();
@@ -955,6 +962,7 @@ private void makeUdta() throws IOException {
             writeMetaItem("©ART", artist);
         }
         if (date != null && !date.isEmpty()) {
+            // this means 'year' in mp4 metadata, who the hell thought that?
             writeMetaItem("©day", date);
         }
 
@@ -1037,8 +1045,11 @@ private byte[] makeMetaHdlr() {
     }
 
     /**
-     * Helper to write cover image inside the 'udta' box.
-     *
+     * Helper to add cover image inside the 'udta' box.
+     * <p>
+     * This method writes the 'covr' metadata item which contains the cover image.
+     * The cover image is displayed as thumbnail in many media players and file managers.
+     * </p>
      * <pre>
      *     [size][key] [data_box]
      *     data_box = [size]["data"][type(4bytes)][locale(4bytes)=0][payload]

app/src/main/java/us/shandian/giga/postprocessing/Postprocessing.java

@@ -4,6 +4,7 @@
 import android.util.Log;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 
 import org.schabi.newpipe.extractor.stream.StreamInfo;
 import org.schabi.newpipe.streams.io.SharpStream;
@@ -33,7 +34,7 @@ public abstract class Postprocessing implements Serializable {
     public transient static final String ALGORITHM_OGG_FROM_WEBM_DEMUXER = "webm-ogg-d";
 
     public static Postprocessing getAlgorithm(@NonNull String algorithmName, String[] args,
-                                              StreamInfo streamInfo) {
+                                              @NonNull StreamInfo streamInfo) {
         Postprocessing instance;
 
         switch (algorithmName) {
@@ -80,7 +81,18 @@ public static Postprocessing getAlgorithm(@NonNull String algorithmName, String[
     private final String name;
 
     private String[] args;
+
+    /**
+     * StreamInfo object related to the current download
+     */
+    @NonNull
     protected StreamInfo streamInfo;
+
+    /**
+     * The thumbnail / cover art bitmap associated with the current download.
+     * May be null.
+     */
+    @Nullable
     protected Bitmap thumbnail;
 
     private transient DownloadMission mission;

checkstyle/checkstyle.xml

@@ -79,7 +79,9 @@
         <module name="JavadocMethod"/>
         <module name="JavadocType"/>
         <!--<module name="JavadocVariable"/>-->
-        <module name="JavadocStyle"/>
+        <module name="JavadocStyle">
+            <property name="additionalJavadocTags" value="implNote"/>
+        </module>
         <!--<module name="MissingJavadocMethod"/>-->
 
         <!-- Checks for Naming Conventions.                  -->