Skip to content

Commit

Permalink
Add missing @param tags
Browse files Browse the repository at this point in the history
Dackka generates a warning if a method has at least one `@param` tag,
but not all of them are documented.

#minor-release

PiperOrigin-RevId: 513873453
  • Loading branch information
icbaker authored and rohitjoins committed Mar 7, 2023
1 parent c0459e6 commit cb7d565
Show file tree
Hide file tree
Showing 30 changed files with 57 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -813,6 +813,7 @@ public long getAdDurationUs(int adGroupIndex, int adIndexInAdGroup) {
* adGroupIndex}, or {@link AdPlaybackState#AD_STATE_UNAVAILABLE} if not yet known.
*
* @param adGroupIndex The ad group index.
* @param adIndexInAdGroup The index of the ad in the ad group.
* @return The state of the ad, or {@link AdPlaybackState#AD_STATE_UNAVAILABLE} if not yet
* known.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,7 @@ public boolean isTypeSupported(@C.TrackType int trackType) {
* Returns true if at least one track of type {@code trackType} is {@link
* Group#isTrackSupported(int, boolean) supported}.
*
* @param trackType The track type to query support for.
* @param allowExceedsCapabilities Whether to consider the track as supported if it has a
* supported {@link Format#sampleMimeType MIME type}, but otherwise exceeds the advertised
* capabilities of the device. For example, a video track for which there's a corresponding
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1557,6 +1557,7 @@ public static long getMediaDurationForPlayoutDuration(long playoutDuration, floa
* Returns the playout duration of {@code mediaDuration} of media.
*
* @param mediaDuration The duration to scale.
* @param speed The factor by which playback is sped up.
* @return The scaled duration, in the same units as {@code mediaDuration}.
*/
@UnstableApi
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ public static byte[] readToEnd(DataSource dataSource) throws IOException {
* array containing the read data.
*
* @param dataSource The source from which to read.
* @param length The number of bytes to read.
* @return The read data.
* @throws IOException If an error occurs reading from the source.
* @throws IllegalStateException If the end of the source was reached before {@code length} bytes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ public DefaultDataSource createDataSource() {
* Constructs a new instance, optionally configured to follow cross-protocol redirects.
*
* @param context A context.
* @param allowCrossProtocolRedirects Whether to allow cross-protocol redirects.
*/
@UnstableApi
public DefaultDataSource(Context context, boolean allowCrossProtocolRedirects) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ public int getTextureId(long presentationTimeUs) throws VideoFrameProcessingExce
/**
* Creates a {@link BitmapOverlay} that shows the {@code overlayBitmap} in the same position and
* size throughout the whole video.
*
* @param overlayBitmap The bitmap to overlay on the video.
*/
public static BitmapOverlay createStaticBitmapOverlay(Bitmap overlayBitmap) {
return new BitmapOverlay() {
Expand All @@ -105,6 +107,7 @@ public Bitmap getBitmap(long presentationTimeUs) {
* Creates a {@link BitmapOverlay} that shows the {@code overlayBitmap} in the same {@link
* OverlaySettings} throughout the whole video.
*
* @param overlayBitmap The bitmap to overlay on the video.
* @param overlaySettings The {@link OverlaySettings} configuring how the overlay is displayed on
* the frames.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ public SpannableString getText(long presentationTimeUs) {
* Creates a {@link TextOverlay} that shows the {@code overlayText} with the same {@link
* OverlaySettings} throughout the whole video.
*
* @param overlayText The text to overlay on the video.
* @param overlaySettings The {@link OverlaySettings} configuring how the overlay is displayed on
* the frames.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,8 @@ public static ExoPlaybackException createForSource(IOException cause, int errorC
* Creates an instance of type {@link #TYPE_RENDERER}.
*
* @param cause The cause of the failure.
* @param rendererName The {@linkplain Renderer#getName() name} of the renderer in which the
* failure occurred.
* @param rendererIndex The index of the renderer in which the failure occurred.
* @param rendererFormat The {@link Format} the renderer was using at the time of the exception,
* or null if the renderer wasn't using a {@link Format}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ public static OfflineLicenseHelper newWidevineInstance(
* their own license URL.
* @param forceDefaultLicenseUrl Whether to use {@code defaultLicenseUrl} for key requests that
* include their own license URL.
* @param dataSourceFactory A factory from which to obtain {@link DataSource} instances.
* @param optionalKeyRequestParameters An optional map of parameters to pass as the last argument
* to {@link MediaDrm#getKeyRequest}. May be null.
* @param eventDispatcher A {@link DrmSessionEventListener.EventDispatcher} used to distribute
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,7 @@ private static String buildCustomDiagnosticInfo(int errorCode) {

/**
* @param trackType The {@link C.TrackType track type} that the renderer handles.
* @param codecAdapterFactory A factory for {@link MediaCodecAdapter} instances.
* @param mediaCodecSelector A decoder selector.
* @param enableDecoderFallback Whether to enable fallback to lower-priority decoders if decoder
* initialization fails. This may result in using a decoder that is less efficient or slower
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,7 @@ public final void remove() {
/**
* Loads and parses a manifest.
*
* @param dataSource The source to use when loading the manifest.
* @param dataSpec The manifest {@link DataSpec}.
* @param removing Whether the manifest is being loaded as part of the download being removed.
* @return The loaded manifest.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2446,6 +2446,7 @@ private void setParametersInternal(Parameters parameters) {
* renderer, track group and track (in that order).
* @param rendererMixedMimeTypeAdaptationSupports The {@link AdaptiveSupport} for mixed MIME type
* adaptation for the renderer.
* @param params The parameters to use for the track selection.
* @return The {@link ExoTrackSelection.Definition}s for the renderers. A null entry indicates no
* selection was made.
* @throws ExoPlaybackException If an error occurs while selecting the tracks.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,7 @@ public TrackGroupArray getTrackGroups(int rendererIndex) {
*
* @param rendererIndex The renderer index.
* @param groupIndex The index of the track group.
* @param trackIndices The indices of the tracks in the track group for which to query support.
* @return The {@link AdaptiveSupport}.
*/
public @AdaptiveSupport int getAdaptiveSupport(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,15 @@ public Factory(int seed) {
private int selectedIndex;

/**
* Creates a new instance.
*
* @param group The {@link TrackGroup}. Must not be null.
* @param tracks The indices of the selected tracks within the {@link TrackGroup}. Must not be
* null or empty. May be in any order.
* @param type The {@link Type} of this track selection.
* @param random A source of random numbers.
*/
public RandomTrackSelection(TrackGroup group, int[] tracks, int type, Random random) {
public RandomTrackSelection(TrackGroup group, int[] tracks, @Type int type, Random random) {
super(group, tracks, type);
this.random = random;
selectedIndex = random.nextInt(length);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -651,6 +651,7 @@ protected final void setOutput(@Nullable Object output) {
*
* <p>The default implementation does not allow decoder reuse.
*
* @param decoderName The name of the decoder.
* @param oldFormat The previous format.
* @param newFormat The new format.
* @return The result of the evaluation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ interface Factory {
* if unknown.
* @param enableEventMessageTrack Whether to output an event message track.
* @param closedCaptionFormats The {@link Format Formats} of closed caption tracks to be output.
* @param playerEmsgHandler The track output to write emsg messages to, or null if emsgs
* shouldn't be written.
* @param transferListener The transfer listener which should be informed of any data transfers.
* May be null if no listener is available.
* @param playerId The {@link PlayerId} of the player using this chunk source.
Expand All @@ -75,8 +77,9 @@ DashChunkSource createDashChunkSource(
* Updates the manifest.
*
* @param newManifest The new manifest.
* @param newPeriodIndex The index of the period covered by {@code newManifest}.
*/
void updateManifest(DashManifest newManifest, int periodIndex);
void updateManifest(DashManifest newManifest, int newPeriodIndex);

/**
* Updates the track selection.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,13 +104,17 @@ public final class HlsMediaPeriod implements MediaPeriod, HlsPlaylistTracker.Pla
* be null if no listener is available.
* @param drmSessionManager The {@link DrmSessionManager} to acquire {@link DrmSession
* DrmSessions} with.
* @param drmEventDispatcher A {@link DrmSessionEventListener.EventDispatcher} used to distribute
* DRM-related events.
* @param loadErrorHandlingPolicy A {@link LoadErrorHandlingPolicy}.
* @param eventDispatcher A dispatcher to notify of events.
* @param allocator An {@link Allocator} from which to obtain media buffer allocations.
* @param compositeSequenceableLoaderFactory A factory to create composite {@link
* SequenceableLoader}s for when this media source loads data from multiple streams.
* @param allowChunklessPreparation Whether chunkless preparation is allowed.
* @param metadataType The type of metadata to extract from the period.
* @param useSessionKeys Whether to use #EXT-X-SESSION-KEY tags.
* @param playerId The ID of the current player.
*/
public HlsMediaPeriod(
HlsExtractorFactory extractorFactory,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -462,16 +462,20 @@ public RenditionReport(Uri playlistUri, long lastMediaSequence, int lastPartInde
public final ServerControl serverControl;

/**
* Constructs an instance.
*
* @param playlistType See {@link #playlistType}.
* @param baseUri See {@link #baseUri}.
* @param tags See {@link #tags}.
* @param startOffsetUs See {@link #startOffsetUs}.
* @param preciseStart See {@link #preciseStart}.
* @param startTimeUs See {@link #startTimeUs}.
* @param hasDiscontinuitySequence See {@link #hasDiscontinuitySequence}.
* @param discontinuitySequence See {@link #discontinuitySequence}.
* @param mediaSequence See {@link #mediaSequence}.
* @param version See {@link #version}.
* @param targetDurationUs See {@link #targetDurationUs}.
* @param partTargetDurationUs See {@link #partTargetDurationUs}.
* @param hasIndependentSegments See {@link #hasIndependentSegments}.
* @param hasEndTag See {@link #hasEndTag}.
* @param hasProgramDateTime See {@link #hasProgramDateTime}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ public static boolean checkFrameHeaderFromPeek(
* there is no guarantee on the peek position.
*
* @param input Input stream to get the sample number from (starting from the read position).
* @param flacStreamMetadata The FLAC metadata of the stream.
* @return The frame first sample number.
* @throws ParserException If an error occurs parsing the sample number.
* @throws IOException If peeking from the input fails.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,12 +152,13 @@ public void setTargetVoice(String targetVoice) {
* <li>Universal selector matching scores 1.
* </ul>
*
* <p>See also <a href="https://www.w3.org/TR/CSS2/cascade.html">CSS Cascading</a>.
*
* @param id The id of the cue if present, {@code null} otherwise.
* @param tag Name of the tag, {@code null} if it refers to the entire cue.
* @param classes An array containing the classes the tag belongs to. Must not be null.
* @param voice Annotated voice if present, {@code null} otherwise.
* @return The score of the match, zero if there is no match.
* @see <a href="https://www.w3.org/TR/CSS2/cascade.html">CSS Cascading</a>
*/
public int getSpecificityScore(
@Nullable String id, @Nullable String tag, Set<String> classes, @Nullable String voice) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -817,6 +817,7 @@ public BitmapLoader getBitmapLoader() {
*
* <p>A command is not accepted if it is not a custom command.
*
* @param controller The controller to send the custom command to.
* @param command A custom command.
* @param args A {@link Bundle} for additional arguments. May be empty.
* @return A {@link ListenableFuture} of {@link SessionResult} from the controller.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1098,7 +1098,10 @@ public static final class ExecuteRunnable extends Action {
private final Runnable runnable;

/**
* Constructs an instance.
*
* @param tag A tag to use for logging.
* @param runnable The runnable to run.
*/
public ExecuteRunnable(@Size(max = 23) String tag, Runnable runnable) {
super(tag, "ExecuteRunnable");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -349,14 +349,15 @@ public Builder setAudioAttributes(AudioAttributes audioAttributes, boolean handl
}

/**
* Schedules a set media items action to be executed.
* Schedules a set media source actions to be executed.
*
* @param mediaItemIndex The media item index to start playback from or {@link C#INDEX_UNSET} if
* the playback position should not be reset.
* @param positionMs The position in milliseconds from where playback should start. If {@link
* C#TIME_UNSET} is passed the default position is used. In any case, if {@code
* mediaItemIndex} is set to {@link C#INDEX_UNSET} the position is not reset at all and this
* parameter is ignored.
* @param sources The media sources to be set on the player.
* @return The builder, for convenience.
*/
@CanIgnoreReturnValue
Expand All @@ -365,9 +366,10 @@ public Builder setMediaSources(int mediaItemIndex, long positionMs, MediaSource.
}

/**
* Schedules a set media items action to be executed.
* Schedules a set media sources action to be executed.
*
* @param resetPosition Whether the playback position should be reset.
* @param sources The media sources to be set on the player.
* @return The builder, for convenience.
*/
@CanIgnoreReturnValue
Expand Down Expand Up @@ -490,6 +492,7 @@ public Builder setShuffleModeEnabled(boolean shuffleModeEnabled) {
/**
* Schedules sending a {@link PlayerMessage}.
*
* @param target A message target.
* @param positionMs The position in the current media item at which the message should be sent,
* in milliseconds.
* @return The builder, for convenience.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,8 @@ public static Bitmap createArgb8888BitmapFromRgba8888Image(Image image) {
/**
* Returns a solid {@link Bitmap} with every pixel having the same color.
*
* @param width The width of image to create, in pixels.
* @param height The height of image to create, in pixels.
* @param color An RGBA color created by {@link Color}.
*/
public static Bitmap createArgb8888BitmapWithSolidColor(int width, int height, int color) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,9 @@ public static void assertBehavior(
*
* <p>The output of the extractor is compared against prerecorded dump files.
*
* @param factory An {@link ExtractorFactory} which creates instances of the {@link Extractor}
* class which is to be tested.
* @param file The input file to pass to the extractor.
* @param assertionConfig Details of how to read and process the source and dump files.
* @param simulationConfig Details on the environment to simulate and behaviours to assert.
* @throws IOException If reading from the input fails.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,7 @@ public boolean isLoading() {
/**
* Creates a new {@link FakeSampleStream}.
*
* @param allocator An {@link Allocator} from which to obtain media buffer allocations.
* @param mediaSourceEventDispatcher A {@link MediaSourceEventListener.EventDispatcher} to notify
* of media events.
* @param drmSessionManager A {@link DrmSessionManager} for DRM interactions.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,7 @@ public List<MediaPeriodId> getCreatedMediaPeriods() {
* @param allocator An {@link Allocator} from which to obtain media buffer allocations.
* @param mediaSourceEventDispatcher An {@link MediaSourceEventListener.EventDispatcher} to
* dispatch media source events.
* @param drmSessionManager A {@link DrmSessionManager} to allow DRM interactions.
* @param drmEventDispatcher An {@link MediaSourceEventListener.EventDispatcher} to dispatch DRM
* events.
* @param transferListener The transfer listener which should be informed of any data transfers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,7 @@ public FakeTimeline(TimelineWindowDefinition... windowDefinitions) {
/**
* Creates a fake timeline with the given window definitions.
*
* @param manifests The manifests of the windows.
* @param windowDefinitions A list of {@link TimelineWindowDefinition}s.
*/
public FakeTimeline(Object[] manifests, TimelineWindowDefinition... windowDefinitions) {
Expand All @@ -403,6 +404,8 @@ public FakeTimeline(Object[] manifests, TimelineWindowDefinition... windowDefini
* Creates a fake timeline with the given window definitions and {@link
* androidx.media3.exoplayer.source.ShuffleOrder}.
*
* @param manifests The manifests of the windows.
* @param shuffleOrder A shuffle ordering for the windows.
* @param windowDefinitions A list of {@link TimelineWindowDefinition}s.
*/
public FakeTimeline(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ public MediaPeriod createPeriod(final MediaPeriodId periodId) {
* playback thread, asserting that a non-null {@link MediaPeriod} is returned.
*
* @param periodId The id of the period to create.
* @param startPositionUs The expected start position, in microseconds.
* @return The created {@link MediaPeriod}.
*/
public MediaPeriod createPeriod(final MediaPeriodId periodId, long startPositionUs) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ public static void assertEmpty(Timeline timeline) {
/**
* Asserts that window tags are set correctly.
*
* @param timeline The timeline to read actual window tags from.
* @param expectedWindowTags A list of expected window tags. If a tag is unknown or not important
* {@code null} can be passed to skip this window.
*/
Expand Down

0 comments on commit cb7d565

Please sign in to comment.