Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Generator ¶
type Generator struct { // WriteSchema tells the generator to output the JSON schema used by doc generation. WriteSchema bool `marker:",optional"` // Format specifies the output format for the documenation. Supported types // are adoc (asciidoc) and md (markdown). Defaults to adoc. Format string `marker:",optional"` // Depth specifies the number of levels to include in the main page. Definitions // at greater depth are moved to their own pages Depth *int `marker:",optional"` // contains filtered or unexported fields }
Generator generates documentation from kinds.
func (Generator) CheckFilter ¶
func (Generator) CheckFilter() loader.NodeFilter
Click to show internal directories.
Click to hide internal directories.