Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶ added in v0.2.0
type Client struct {
// contains filtered or unexported fields
}
Client represents an active cli-docs-tool object
func (*Client) GenAllTree ¶ added in v0.2.0
GenAllTree creates all structured ref files for this command and all descendants in the directory given.
func (*Client) GenMarkdownTree ¶ added in v0.2.0
GenMarkdownTree will generate a markdown page for this command and all descendants in the directory given.
func (*Client) GenYamlTree ¶ added in v0.2.0
GenYamlTree creates yaml structured ref files for this command and all descendants in the directory given. This function may not work correctly if your command names have `-` in them. If you have `cmd` with two subcmds, `sub` and `sub-third`, and `sub` has a subcommand called `third` it is undefined which help output will be in the file `cmd-sub-third.1`.
Source Files ¶
Click to show internal directories.
Click to hide internal directories.