diff --git a/README.md b/README.md index adfb16c9a..75ba3832f 100644 --- a/README.md +++ b/README.md @@ -307,6 +307,8 @@ protobuf.load("bundle.json", function(err, root) { }); ``` +**ProTip!** Documenting your .proto files with `/** ... */`-blocks translates to generated static code. + ### Generating TypeScript definitions from static modules Likewise, the `pbts` command line utility can be used to generate TypeScript definitions from `pbjs`-generated static modules. diff --git a/tests/data/comments.proto b/tests/data/comments.proto index 655301885..81dd643d0 100644 --- a/tests/data/comments.proto +++ b/tests/data/comments.proto @@ -30,9 +30,7 @@ message Test2 { */ enum Test3 { - /** - * Value with a comment. - */ + /** Value with a comment. */ ONE = 1; // Value with no comment.