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

doc improvement #737

Closed
yimingwangdell opened this issue Sep 24, 2023 · 1 comment
Closed

doc improvement #737

yimingwangdell opened this issue Sep 24, 2023 · 1 comment

Comments

@yimingwangdell
Copy link

yimingwangdell commented Sep 24, 2023

for beginner, it's very hard to find the rule:
// In addition to the default 'src/main/proto'
it took me 2 hours to find out why file is not generated. User may think this plugin will scan all the .proto files in project.

for protoc, it's easy to understand where to find what's the input, what's the output:
./protoc -I=$SRC_DIR --java_out=$DST_DIR $SRC_DIR/AddressBook.protos

please help to improve it by add the rule of generating java file in the beginning of document.

@ejona86
Copy link
Collaborator

ejona86 commented Sep 25, 2023

it took me 2 hours to find out why file is not generated.

So you read that comment and didn't understand it, or it took you two hours to find that comment? To my knowledge, no plugin scans all files within a project. Did you happen to take a look at the example?

No, we don't want to include the protoc invocation. Java users generally have no experience with the protoc command and seem to be afraid of it.

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

No branches or pull requests

2 participants