Skip to content

Remove unnecessary @hide doc tags from non-public AndroidX Test APIs. - #2529

Open
copybara-service[bot] wants to merge 1 commit into
mainfrom
piper_1015488810
Open

copybara-service[bot] wants to merge 1 commit into
mainfrom
piper_1015488810

Conversation

@copybara-service

@copybara-service copybara-service Bot commented Nov 6, 2026 •

Copy link
Copy Markdown

Remove unnecessary @hide doc tags from non-public AndroidX Test APIs.

Remove redundant @hide Javadoc, KDoc, and AIDL doc tags from 8
package-private, Kotlin internal, compile-only stub, or AIDL
declarations in androidx.test that are already excluded from or
unaffected by public API and reference documentation generation without
@hide doc tags.

Removing unnecessary @hide doc tags:

  • Unlocks passing --ignore-comments on API signature generation,
    improving build performance and memory usage by skipping Javadoc/KDoc
    extraction, comment AST parsing, and {@link} import caching.
  • Enables Metalava declarative <api-surfaces> XML configuration,
    which ignores @hide and @removed Javadoc tags by design.
  • Relies on language-level visibility and @RestrictTo annotations
    enforced statically by compilers, Android Lint, and IDEs.

@copybara-service copybara-service Bot changed the title Remove unnecessary @hide doc tags from @RestrictTo APIs in AndroidX Remove unnecessary @hide doc tags from non-public AndroidX Test APIs. Nov 6, 2026
Remove redundant `@hide` Javadoc, KDoc, and AIDL doc tags from 8
package-private, Kotlin `internal`, compile-only stub, or AIDL
declarations in `androidx.test` that are already excluded from or
unaffected by public API and reference documentation generation without
`@hide` doc tags.

Removing unnecessary `@hide` doc tags:
- Unlocks passing `--ignore-comments` on API signature generation,
  improving build performance and memory usage by skipping Javadoc/KDoc
  extraction, comment AST parsing, and `{@link}` import caching.
- Enables Metalava declarative `<api-surfaces>` XML configuration,
  which ignores `@hide` and `@removed` Javadoc tags by design.
- Relies on language-level visibility and `@RestrictTo` annotations
  enforced statically by compilers, Android Lint, and IDEs.

PiperOrigin-RevId: 1015488810

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant