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 javadoc warnings in generated files #6231

Merged
4 commits merged into from
Jun 27, 2019
Merged

Fix javadoc warnings in generated files #6231

4 commits merged into from
Jun 27, 2019

Conversation

ST-DDT
Copy link
Contributor

@ST-DDT ST-DDT commented Jun 8, 2019

Currently the protoc generated java classes will cause javadoc compilation warnings due to missing @param and @return values.

I first thought this was an easy change, but I soon discovered that this takes quite some effort.
That's why I would like to get some feedback whether these changes have a chance to be merged at all / are appreciated.

example diff get

example diff set and clear

This PR is by no means complete, I just changed about 50/430 occurances of WriteFieldDocComment.

@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@ST-DDT
Copy link
Contributor Author

ST-DDT commented Jun 9, 2019

I signed it!

@googlebot
Copy link

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

This generally looks good to me. Thank you for doing this! Would you be willing to follow up with more changes to update the remaining WriteFieldDocComment?

src/google/protobuf/compiler/java/java_doc_comment.cc Outdated Show resolved Hide resolved
src/google/protobuf/compiler/java/java_doc_comment.cc Outdated Show resolved Hide resolved
@ST-DDT
Copy link
Contributor Author

ST-DDT commented Jun 11, 2019

That's the plan. It might take some time, though, as I currently have only limited free time.

@ST-DDT
Copy link
Contributor Author

ST-DDT commented Jun 15, 2019

Progress: 255/450 (55%)

@ghost ghost marked this pull request as ready for review June 18, 2019 19:25
@ghost ghost added the kokoro:run label Jun 18, 2019
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

This is looking very good. Let's hold at this state for now. I want to make sure this can successfully get in (the larger the PR, the harder it is to get in).

src/google/protobuf/compiler/java/java_doc_comment.cc Outdated Show resolved Hide resolved
src/google/protobuf/compiler/java/java_primitive_field.cc Outdated Show resolved Hide resolved
@ST-DDT
Copy link
Contributor Author

ST-DDT commented Jun 24, 2019

Currently it is too hot to concentrate properly. I'll wait with the fixes until it gets a little bit colder.

@ST-DDT
Copy link
Contributor Author

ST-DDT commented Jun 26, 2019

I have fixed the above mentioned issues.

@ghost
Copy link

ghost commented Jun 27, 2019

This looks good. Thank you for improving protobuf!

@ghost ghost merged commit f30c68b into protocolbuffers:master Jun 27, 2019
@ST-DDT ST-DDT deleted the fix-javadoc-warnings branch June 27, 2019 22:02
bithium pushed a commit to bithium/protobuf that referenced this pull request Sep 4, 2023
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants