Docs: Added a hint on documenting .proto files for static code

protobufjs · Jan 12, 2017 · 9e360ea · 9e360ea
1 parent c280a4a
commit 9e360ea
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git 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
@@ -30,9 +30,7 @@ message Test2 {
  */
 enum Test3 {
 
-    /**
-     * Value with a comment.
-     */
+    /** Value with a comment. */
     ONE = 1;
 
     // Value with no comment.