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

Publish the new binder package in releases. #8585

Merged
merged 1 commit into from
Oct 8, 2021
Merged

Conversation

markb74
Copy link
Contributor

@markb74 markb74 commented Oct 7, 2021

No description provided.

@markb74 markb74 requested a review from ejona86 October 7, 2021 17:50
Copy link
Member

@ejona86 ejona86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do see some javadoc warnings that should be cleaned up (separate PR is fine).

> Task :grpc-binder:javadocs
grpc-java/binder/src/main/java/io/grpc/binder/internal/BinderTransport.java:129: warning - Tag @link: reference not found: EARLIEST_SUPPORTED_WIRE_FORMAT_VERSION
grpc-java/binder/src/main/java/io/grpc/binder/internal/BinderTransportSecurity.java:66: warning - Tag @link: reference not found: Attributes.Builder
grpc-java/binder/src/main/java/io/grpc/binder/ParcelableUtils.java:40: warning - Tag @link: reference not found: Metadata.Key
grpc-java/binder/src/main/java/io/grpc/binder/ParcelableUtils.java:53: warning - Tag @link: reference not found: Metadata.Key
grpc-java/binder/src/main/java/io/grpc/binder/ParcelableUtils.java:40: warning - Tag @link: reference not found: Metadata.Key
grpc-java/binder/src/main/java/io/grpc/binder/ParcelableUtils.java:53: warning - Tag @link: reference not found: Metadata.Key
grpc-java/binder/src/main/java/io/grpc/binder/ParcelableUtils.java:40: warning - Tag @link: reference not found: Metadata.Key
grpc-java/binder/src/main/java/io/grpc/binder/ParcelableUtils.java:53: warning - Tag @link: reference not found: Metadata.Key
8 warnings

@ejona86
Copy link
Member

ejona86 commented Oct 7, 2021

Looks like the javadoc is including the internal directory. You probably want something like

javadoc {
exclude 'io/grpc/internal/**'

@markb74
Copy link
Contributor Author

markb74 commented Oct 8, 2021

Re: Internal Javadoc, I tried excluding the internal directory, but that causes the whole task to fail (since the sources still depend on the internal package). It's not clear how to exclude the internal package from javadoc generation but not from the source path.

@markb74 markb74 merged commit 0d25d8f into grpc:master Oct 8, 2021
markb74 added a commit to markb74/grpc-java that referenced this pull request Oct 8, 2021
Note: I didn't fix all javadoc warnings mentioned in grpc#8585, since
they're not generated with a modern java version, and the fix feels
worse than the warning.

Specifically, {@link X.Y} generates a warning if only X is imported,
and {@link Z} generates a warning if Z is declared later in the class.

In particular, attempting to fix the first issue by importing X.Y results
in a code-readability warning suggesting I shouldn't do that.
@ejona86
Copy link
Member

ejona86 commented Oct 9, 2021

@markb74, that's what the javadoc { } block does. You can exclude it just for the javadoc.

markb74 added a commit that referenced this pull request Oct 9, 2021
Note: I didn't fix all javadoc warnings mentioned in #8585, since
they're not generated with a modern java version, and the fix feels
worse than the warning.

Specifically, {@link X.Y} generates a warning if only X is imported,
and {@link Z} generates a warning if Z is declared later in the class.

In particular, attempting to fix the first issue by importing X.Y results
in a code-readability warning suggesting I shouldn't do that.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants