Fix javadocs

pull/527/head^2
Mattia Iavarone 5 years ago
parent 82ce5cd762
commit ab48a33249
  1. 2
      .travis.yml
  2. 5
      cameraview/build.gradle
  3. 2
      cameraview/src/main/java/com/otaliastudios/cameraview/CameraView.java
  4. 7
      cameraview/src/main/java/com/otaliastudios/cameraview/video/encoding/MediaEncoderEngine.java
  5. 2
      cameraview/src/main/java/com/otaliastudios/cameraview/video/encoding/TextureMediaEncoder.java

@ -71,7 +71,7 @@ before_script:
script: script:
- ./gradlew clean testDebugUnitTest connectedCheck mergedCoverageReport - ./gradlew clean demo:assembleDebug cameraview:testDebugUnitTest cameraview:connectedCheck cameraview:mergedCoverageReport cameraview:javadoc
after_success: after_success:
- bash <(curl -s https://codecov.io/bash) -s "*/build/reports/mergedCoverageReport/" - bash <(curl -s https://codecov.io/bash) -s "*/build/reports/mergedCoverageReport/"

@ -161,7 +161,10 @@ task javadoc(type: Javadoc) {
} }
exclude '**/BuildConfig.java' exclude '**/BuildConfig.java'
exclude '**/R.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) { task javadocJar(type: Jar, dependsOn: javadoc) {

@ -785,6 +785,8 @@ public class CameraView extends FrameLayout implements LifecycleObserver {
* For example, if control class is a {@link Grid}, this calls {@link #getGrid()}. * For example, if control class is a {@link Grid}, this calls {@link #getGrid()}.
* *
* @param controlClass desired value class * @param controlClass desired value class
* @param <T> the class type
* @return the control
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
@NonNull @NonNull

@ -333,6 +333,9 @@ public class MediaEncoderEngine {
* *
* This controller should coordinate between firstFrameMillis and skip frames that have * This controller should coordinate between firstFrameMillis and skip frames that have
* large differences. * large differences.
*
* @param pool pool
* @param buffer buffer
*/ */
public void write(@NonNull OutputBufferPool pool, @NonNull OutputBuffer buffer) { public void write(@NonNull OutputBufferPool pool, @NonNull OutputBuffer buffer) {
if (DEBUG_PERFORMANCE) { if (DEBUG_PERFORMANCE) {
@ -361,6 +364,8 @@ public class MediaEncoderEngine {
* To be used when maxLength / maxSize constraints are reached, for example. * To be used when maxLength / maxSize constraints are reached, for example.
* *
* When this succeeds, {@link MediaEncoder#stop()} is called. * When this succeeds, {@link MediaEncoder#stop()} is called.
*
* @param track track
*/ */
public void requestStop(int track) { public void requestStop(int track) {
synchronized (mControllerLock) { synchronized (mControllerLock) {
@ -383,6 +388,8 @@ public class MediaEncoderEngine {
/** /**
* Notifies that the encoder was stopped. After this is called by all encoders, * Notifies that the encoder was stopped. After this is called by all encoders,
* we will actually stop the muxer. * we will actually stop the muxer.
*
* @param track track
*/ */
public void notifyStopped(int track) { public void notifyStopped(int track) {
synchronized (mControllerLock) { synchronized (mControllerLock) {

@ -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 * 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. * that we'll be drawing the same frame twice.
* *

Loading…
Cancel
Save