Created by: NathanBaulch
The generated godoc comments are not idiomatic and produce ugly formatting when using the godoc tool and in popular IDEs like GoLand.
- Switch to double slash comments for single line godocs (ie, comments without
notes
) - Remove asterisks prefix in multi-line comments
- Extra blank lines to force new paragraphs
- Indent @ prefixed metadata to ensure new line between each (these directives are not recognized in Go, but it's a start)
- Emit special "Deprecated" comment where applicable
@antihax @grokify @kemokemo @jirikuncar @ph4r5h4d
PR checklist
-
Read the contribution guidelines. -
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community. -
Run the following to build the project and update samples: ./mvnw clean package ./bin/generate-samples.sh ./bin/utils/export_docs_generators.sh
./bin/generate-samples.sh bin/configs/java*
. For Windows users, please run the script in Git BASH. -
File the PR against the correct branch: master
,5.3.x
,6.0.x
-
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.