Documentation
¶
Overview ¶
Package gen provides a command to generate documentation for a Go package.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// Title for the documentation, if empty the package name is used.
Title string `json:"title"`
// A list of sections to include in the documentation.
//
// Available sections:
// - constants
// - factories
// - functions
// - methods
// - types
// - variables
//
// if empty all sections are included.
IncludeSections []string `json:"includeSections"`
// A list of folders to exclude from the documentation.
// if empty nothing is excluded.
ExcludePaths []string `json:"excludePaths"`
// Read all files in the package and generate the documentation.
// it can be used in combination with include, and exclude.
Recursive bool `json:"recursive"`
// Respect case when matching symbols
RespectCase bool `json:"respectCase"`
// One-line representation for each symbol
Short bool `json:"short"`
// Print source code for each symbol
PrintSource bool `json:"printSource"`
// Include unexported symbols
Unexported bool `json:"unexported"`
// SkipSubPackages will omit the sub packages Section from the README.
SkipSubPkgs bool `json:"skipSubPkgs"`
// SkipExamples will omit the examples from the README.
SkipExamples bool `json:"skipExamples"`
}
Config is used to configure the documentation generation.
Click to show internal directories.
Click to hide internal directories.