Skip to content

Command protoc-gen-docs is the protoc plugin to generate documentation from the Protocol Buffers definitions.

License

Notifications You must be signed in to change notification settings

protobuf-tools/protoc-gen-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

protoc-gen-docs

Go Reference

Command protoc-gen-docs is the protoc plugin to generate documentation from the Protocol Buffers definitions.

Philosophy

Note

Documentation is one of the most critical aspects of API design.

Users of your API are unable to dig into the implementation to understand the API better; often, the API surface definition and its corresponding documentation will be the only things a user has.

Therefore, it is important that documentation be as clear, complete, and unambiguous as possible.


Note

Precisely, Concisely Document Most Fields and Messages


Note

Over-document, and use complete sentences for comments.

About

Command protoc-gen-docs is the protoc plugin to generate documentation from the Protocol Buffers definitions.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published

Languages