Retracted: Versions before v0.1.3 predate the public release; use v0.1.3 or later.
Predate the public release; superseded by v0.1.3.
Documentation
¶
Index ¶
Constants ¶
const ( FormatMarkdown = "markdown" FormatYAML = "yaml" )
Define output format types
Variables ¶
This section is empty.
Functions ¶
func GenerateMarkdown ¶
GenerateMarkdown is a convenience function to generate markdown documentation directly
func GenerateYAML ¶
GenerateYAML is a convenience function to generate YAML configuration template directly
Types ¶
type AppInfo ¶
type AppInfo struct {
BinaryName string
EnvPrefix string
ConfigPaths struct {
DefaultPath string
DefaultFullName string
}
}
AppInfo contains information about the application needed for documentation generation
type Config ¶
type Config struct {
OutputFormat string
OutputFile string
Writer io.Writer
Registry RegistryFunc
}
Config holds all configuration for document generation
type Generator ¶
type Generator struct {
// contains filtered or unexported fields
}
Generator handles document generation based on configuration
func NewGenerator ¶
NewGenerator creates a new document generator with the given configuration
func (*Generator) GenerateMarkdownDocs ¶
GenerateMarkdownDocs generates Markdown documentation for all configuration options
func (*Generator) GenerateYAMLDocs ¶
GenerateYAMLDocs generates a YAML configuration template
func (*Generator) SetAppInfo ¶
SetAppInfo sets the application information used for documentation
type RegistryFunc ¶
type RegistryFunc func() []config.ConfigOption
RegistryFunc defines a function that returns a configuration registry This is primarily used for testing to mock the registry
Source Files