Skip to content

Remove redundant @hide doc tags from internal AndroidX Test APIs. - #2530

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

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

Conversation

@copybara-service

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

Copy link
Copy Markdown

Remove redundant @hide doc tags from internal AndroidX Test APIs.

Remove redundant @hide Javadoc and KDoc tags across 166 source and
package-info.java files whose public or protected declarations are
hidden from API signature and reference documentation generation via
visibility annotations or package filters.

Relying on annotations instead of @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.
  • Keeps visibility enforced statically by compilers, Android Lint, and
    IDEs via @RestrictTo rather than unchecked doc comments.

@copybara-service copybara-service Bot changed the title Remove redundant @hide doc tags from @RestrictTo AndroidX Test APIs. Remove redundant @hide doc tags from internal AndroidX Test APIs. Nov 6, 2026
Remove redundant `@hide` Javadoc and KDoc tags across 166 source and
`package-info.java` files whose public or protected declarations are
hidden from API signature and reference documentation generation via
visibility annotations or package filters.

Relying on annotations instead of `@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.
- Keeps visibility enforced statically by compilers, Android Lint, and
  IDEs via `@RestrictTo` rather than unchecked doc comments.

PiperOrigin-RevId: 1015528042

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