From 9e360ea6a74d41307483e51f18769df7f5b047b9 Mon Sep 17 00:00:00 2001
From: dcodeIO <dcode@dcode.io>
Date: Fri, 13 Jan 2017 00:46:03 +0100
Subject: [PATCH] Docs: Added a hint on documenting .proto files for static
 code

---
 README.md                 | 2 ++
 tests/data/comments.proto | 4 +---
 2 files changed, 3 insertions(+), 3 deletions(-)

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.