Skip to content

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

Merged
copybara-service[bot] merged 1 commit into
mainfrom
piper_1015528042
Nov 10, 2026
Merged

copybara-service[bot] merged 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 162 source and
package-info.java files whose public or protected declarations are
hidden from API signature and reference documentation generation via
visibility annotations.

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
@copybara-service
copybara-service Bot force-pushed the piper_1015528042 branch 4 times, most recently from e41d49c to 2fe7293 Compare November 10, 2026 09:55
Remove redundant `@hide` Javadoc and KDoc tags across 162 source and
`package-info.java` files whose public or protected declarations are
hidden from API signature and reference documentation generation via
visibility annotations.

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: 1018036843
@copybara-service
copybara-service Bot merged commit 86ad26f into main Nov 10, 2026
4 checks passed
@copybara-service
copybara-service Bot deleted the piper_1015528042 branch November 10, 2026 10:07
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