Skip to content

Commit 1f177d7

Browse files
committed
*: add more examples
1 parent f1d66c3 commit 1f177d7

File tree

3 files changed

+873
-3
lines changed

3 files changed

+873
-3
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55

66
protodoc generates Protocol Buffer documentation.
77

8+
```
9+
go get -v -u github.com/coreos/protodoc
10+
11+
prodoc ./parse/testdata --language-options="Go,C++,Java,Python" --title="testdata" --target-path="./sample.md"
12+
```
13+
814
Note that parser only understands the minimum syntax
915
of Protocol Buffer (just enough to generate documentation).
1016

main.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@
1818
// protodoc [flags]
1919
//
2020
// Flags:
21-
// -o, --languags value language options in field descriptions (default [Go,C++,Java,Python])
22-
// -p, --target-path string file path to save the documentation
23-
// -t, --title string title of documentation
21+
// -h, --help help for protodoc
22+
// -o, --languages value language options in field descriptions (default [Go,C++,Java,Python])
23+
// -p, --target-path string file path to save the documentation
24+
// -t, --title string title of documentation
2425
//
2526
package main
2627

0 commit comments

Comments
 (0)