Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some javadoc errors #8375

Merged
merged 2 commits into from Jul 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/workflows/gradle_tasks_validation.yml
Expand Up @@ -49,6 +49,23 @@ jobs:
- name: Run aggregateDocs
run: ./gradlew clean aggregateDocs

run_javadocJar:
runs-on: ubuntu-22.04

steps:
- uses: actions/checkout@v3

- name: Set up JDK
uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 11

- uses: gradle/gradle-build-action@v2

- name: Run javadocJar
run: ./gradlew clean javadocJar

run_instrumentAll:
runs-on: ubuntu-22.04

Expand Down
Expand Up @@ -30,8 +30,7 @@ public static AudioDeviceInfoBuilder newBuilder() {
* Sets the device type.
*
* @param type The device type. The possible values are the constants defined as <a
* href=https://cs.android.com/android/platform/superproject/+/master:frameworks/base/media/java/android/media/AudioDeviceInfo.java?q=AudioDeviceType>
* {@code AudioDeviceInfo.AudioDeviceType}</a>
* href="https://cs.android.com/android/platform/superproject/+/master:frameworks/base/media/java/android/media/AudioDeviceInfo.java?q=AudioDeviceType">AudioDeviceInfo.AudioDeviceType</a>
*/
public AudioDeviceInfoBuilder setType(int type) {
this.type = type;
Expand Down
Expand Up @@ -191,9 +191,8 @@ public static CodecCapabilitiesBuilder newBuilder() {
*
* @param mediaFormat a {@link MediaFormat} supported by the codec. It is a requirement for
* mediaFormat to have {@link MediaFormat.KEY_MIME} set. Other keys are optional.
* @throws {@link NullPointerException} if mediaFormat is null.
* @throws {@link IllegalArgumentException} if mediaFormat does not have {@link
* MediaFormat.KEY_MIME}.
* @throws NullPointerException if mediaFormat is null.
* @throws IllegalArgumentException if mediaFormat does not have {@link MediaFormat.KEY_MIME}.
*/
public CodecCapabilitiesBuilder setMediaFormat(MediaFormat mediaFormat) {
Preconditions.checkNotNull(mediaFormat);
Expand All @@ -220,7 +219,7 @@ public CodecCapabilitiesBuilder setIsEncoder(boolean isEncoder) {
*
* @param profileLevels an array of {@link MediaCodecInfo.CodecProfileLevel} supported by the
* codec.
* @throws {@link NullPointerException} if profileLevels is null.
* @throws NullPointerException if profileLevels is null.
*/
public CodecCapabilitiesBuilder setProfileLevels(CodecProfileLevel[] profileLevels) {
this.profileLevels = Preconditions.checkNotNull(profileLevels);
Expand Down
Expand Up @@ -34,8 +34,10 @@
* Java representation of framework native input Transliterated from oreo-mr1 (SDK 27)
* frameworks/native/include/input/Input.h and libs/input/Input.cpp
*
* @see <a href="https://android.googlesource.com/platform/frameworks/native/+/oreo-mr1-release/include/input/Input.h">include/input/Input.h</a>
* @see <a href="https://android.googlesource.com/platform/frameworks/native/+/oreo-mr1-release/libs/input/Input.cpp>libs/input/Input.cpp</a>
* @see <a
* href="https://android.googlesource.com/platform/frameworks/native/+/oreo-mr1-release/include/input/Input.h">include/input/Input.h</a>
* @see <a
* href="https://android.googlesource.com/platform/frameworks/native/+/oreo-mr1-release/libs/input/Input.cpp">libs/input/Input.cpp</a>
*/
public class NativeInput {

Expand Down
Expand Up @@ -207,7 +207,7 @@ public void setTasks(List<ActivityManager.RunningTaskInfo> tasks) {
* Sets the values to be returned by {@link #getAppTasks()}.
*
* @see #getAppTasks()
* @param tasks List of app tasks.
* @param appTasks List of app tasks.
*/
public void setAppTasks(List<ActivityManager.AppTask> appTasks) {
this.appTasks.clear();
Expand Down
Expand Up @@ -6,8 +6,10 @@
/**
* The shadow API for {@link AsyncTaskLoader}.
*
* Different shadow implementations will be used based on the current {@link LooperMode.Mode}.
* @see ShadowLegacyAsyncTaskLoader, ShadowPausedAsyncTaskLoader
* <p>Different shadow implementations will be used based on the current {@link LooperMode.Mode}.
*
* @see ShadowLegacyAsyncTaskLoader
* @see ShadowPausedAsyncTaskLoader
*/
@Implements(value = AsyncTaskLoader.class, shadowPicker = ShadowAsyncTaskLoader.Picker.class)
public abstract class ShadowAsyncTaskLoader<D> {
Expand Down
Expand Up @@ -110,7 +110,7 @@ public void setCanAuthenticate(boolean flag) {
*
* @param type to set the authenticatorType
* @see <a
* href="https://developer.android.com/reference/android/hardware/biometrics/BiometricManager#canAuthenticate(int)"
* href="https://developer.android.com/reference/android/hardware/biometrics/BiometricManager#canAuthenticate(int)">BiometricManager#canAuthenticate(int)</a>
*/
public void setAuthenticatorType(int type) {
authenticatorType = type;
Expand Down
Expand Up @@ -24,7 +24,8 @@
* <p>In {@link LooperMode.Mode.LEGACY}, each Message is associated with a Runnable posted to the
* {@link Scheduler}.
*
* @see ShadowLooper, ShadowLegacyMessageQueue
* @see ShadowLooper
* @see ShadowLegacyMessageQueue
*/
@Implements(value = Message.class, isInAndroidSdk = false)
public class ShadowLegacyMessage extends ShadowMessage {
Expand Down
Expand Up @@ -6,9 +6,7 @@
import org.robolectric.annotation.Implementation;
import org.robolectric.annotation.Implements;

/**
* Implement {@lint TextUtils#ellipsize} by truncating the text.
*/
/** Implement {@link TextUtils#ellipsize} by truncating the text. */
@SuppressWarnings({"UnusedDeclaration"})
@Implements(TextUtils.class)
public class ShadowTextUtils {
Expand Down