Permalink
Browse files

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

  • Loading branch information...
dcodeIO committed Jan 12, 2017
1 parent c280a4a commit 9e360ea6a74d41307483e51f18769df7f5b047b9
Showing with 3 additions and 3 deletions.
  1. +2 −0 README.md
  2. +1 −3 tests/data/comments.proto
@@ -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.
@@ -30,9 +30,7 @@ message Test2 {
*/
enum Test3 {
/**
* Value with a comment.
*/
/** Value with a comment. */
ONE = 1;
// Value with no comment.

0 comments on commit 9e360ea

Please sign in to comment.