doc-gen helps you to generate apidoc like comment
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
$ go get github.com/jonyhy96/doc-gen
$ doc-gen -h
$ doc-gen -f examples/models/user.go
$ apidoc -f ".*\\.doc$" -o apidoc // you need have your own apidoc.json first
For develop
- go ^1.10
$ go build -o doc-gen .
$ sudo mv doc-gen /usr/local/bin
| param | required | e.g. |
|---|---|---|
| f | true | -f examples/models/user.go |
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- HAO YUN - Initial work - haoyun
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE file for details
- nothing