Skip to content
This repository has been archived by the owner on Mar 18, 2022. It is now read-only.

Latest commit

 

History

History
21 lines (12 loc) · 549 Bytes

README.md

File metadata and controls

21 lines (12 loc) · 549 Bytes

godocjson

Produces JSON-formatted Go documentation.

Installation

Make sure your Go environment is configured correctly, then run:

go get github.com/rtfd/godocjson

Usage

godocjson [-e <pattern>] <directory>

The godocjson scans for Go packages and outputs JSON-formatted documentation to stdout

The options are as follows:

-e   <pattern>   Exclude files that match specified pattern from processing.
                 Example usage:
                    godocjson -e _test.go ./go/sources/folder