Documentation
¶
Overview ¶
Package docgen provides auto-generation of model documentation from Go types. It uses reflection to introspect struct fields and generate markdown documentation suitable for users who want to understand the data model for custom integrations.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FieldInfo ¶
type FieldInfo struct {
Name string
Type string
Path string
Tags FieldTags
IsOptional bool
IsNested bool
NestedType string
Description string
}
FieldInfo represents documentation for a single struct field.
type Generator ¶
type Generator struct{}
Generator creates documentation from Go types using reflection.
func NewGenerator ¶
func NewGenerator() *Generator
NewGenerator creates a new documentation generator.
func (*Generator) GenerateReference ¶
GenerateReference generates markdown documentation for the given value's type.
Source Files
Click to show internal directories.
Click to hide internal directories.