From ab48a33249af2ad46a7d4c608221be745ab89d5b Mon Sep 17 00:00:00 2001
From: Mattia Iavarone <mat.iavarone@gmail.com>
Date: Sat, 3 Aug 2019 21:47:39 +0200
Subject: [PATCH] Fix javadocs

---
 .travis.yml                                                | 2 +-
 cameraview/build.gradle                                    | 5 ++++-
 .../main/java/com/otaliastudios/cameraview/CameraView.java | 2 ++
 .../cameraview/video/encoding/MediaEncoderEngine.java      | 7 +++++++
 .../cameraview/video/encoding/TextureMediaEncoder.java     | 2 +-
 5 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index db728959..5878a459 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -71,7 +71,7 @@ before_script:
 
 
 script:
-  - ./gradlew clean testDebugUnitTest connectedCheck mergedCoverageReport
+  - ./gradlew clean demo:assembleDebug cameraview:testDebugUnitTest cameraview:connectedCheck cameraview:mergedCoverageReport cameraview:javadoc
 
 after_success:
   - bash <(curl -s https://codecov.io/bash) -s "*/build/reports/mergedCoverageReport/"
diff --git a/cameraview/build.gradle b/cameraview/build.gradle
index e5faef5e..923f85b7 100644
--- a/cameraview/build.gradle
+++ b/cameraview/build.gradle
@@ -161,7 +161,10 @@ task javadoc(type: Javadoc) {
     }
     exclude '**/BuildConfig.java'
     exclude '**/R.java'
-    exclude '**/internal/**' // This excludes our internal folder!
+    // This excludes our internal folder, which is nice, but also creates
+    // errors anytime we reference excluded classes in public classes javadocs,
+    // which is unfortunate. There might be a fix but I don't know any.
+    // exclude '**/internal/**'
 }
 
 task javadocJar(type: Jar, dependsOn: javadoc) {
diff --git a/cameraview/src/main/java/com/otaliastudios/cameraview/CameraView.java b/cameraview/src/main/java/com/otaliastudios/cameraview/CameraView.java
index 94259dd2..38b2b2bb 100644
--- a/cameraview/src/main/java/com/otaliastudios/cameraview/CameraView.java
+++ b/cameraview/src/main/java/com/otaliastudios/cameraview/CameraView.java
@@ -785,6 +785,8 @@ public class CameraView extends FrameLayout implements LifecycleObserver {
      * For example, if control class is a {@link Grid}, this calls {@link #getGrid()}.
      *
      * @param controlClass desired value class
+     * @param <T> the class type
+     * @return the control
      */
     @SuppressWarnings("unchecked")
     @NonNull
diff --git a/cameraview/src/main/java/com/otaliastudios/cameraview/video/encoding/MediaEncoderEngine.java b/cameraview/src/main/java/com/otaliastudios/cameraview/video/encoding/MediaEncoderEngine.java
index 0ee9e60a..5164892a 100644
--- a/cameraview/src/main/java/com/otaliastudios/cameraview/video/encoding/MediaEncoderEngine.java
+++ b/cameraview/src/main/java/com/otaliastudios/cameraview/video/encoding/MediaEncoderEngine.java
@@ -333,6 +333,9 @@ public class MediaEncoderEngine {
          *
          * This controller should coordinate between firstFrameMillis and skip frames that have
          * large differences.
+         *
+         * @param pool pool
+         * @param buffer buffer
          */
         public void write(@NonNull OutputBufferPool pool, @NonNull OutputBuffer buffer) {
             if (DEBUG_PERFORMANCE) {
@@ -361,6 +364,8 @@ public class MediaEncoderEngine {
          * To be used when maxLength / maxSize constraints are reached, for example.
          *
          * When this succeeds, {@link MediaEncoder#stop()} is called.
+         *
+         * @param track track
          */
         public void requestStop(int track) {
             synchronized (mControllerLock) {
@@ -383,6 +388,8 @@ public class MediaEncoderEngine {
         /**
          * Notifies that the encoder was stopped. After this is called by all encoders,
          * we will actually stop the muxer.
+         *
+         * @param track track
          */
         public void notifyStopped(int track) {
             synchronized (mControllerLock) {
diff --git a/cameraview/src/main/java/com/otaliastudios/cameraview/video/encoding/TextureMediaEncoder.java b/cameraview/src/main/java/com/otaliastudios/cameraview/video/encoding/TextureMediaEncoder.java
index c3ce7377..a0e3fe74 100644
--- a/cameraview/src/main/java/com/otaliastudios/cameraview/video/encoding/TextureMediaEncoder.java
+++ b/cameraview/src/main/java/com/otaliastudios/cameraview/video/encoding/TextureMediaEncoder.java
@@ -100,7 +100,7 @@ public class TextureMediaEncoder extends VideoMediaEncoder<TextureConfig> {
     }
 
     /**
-     * Any number of pending events > 1 means that we should skip this frame.
+     * Any number of pending events greater than 1 means that we should skip this frame.
      * To avoid skipping too many frames, we'll use 2 for now, but this just means
      * that we'll be drawing the same frame twice.
      *