Versions in this module Expand all Collapse all v0 v0.3.0 May 26, 2026 v0.2.1 May 26, 2026 Changes in this version + func GenerateREADME(doc *ProjectDoc) string + func RenderHTML(doc *ProjectDoc) string + func RenderMarkdown(doc *ProjectDoc) string + type DocGenerator struct + IncludePrivate bool + MaxDepth int + OutputFormat string + ProjectDir string + func NewDocGenerator(projectDir string) *DocGenerator + func (dg *DocGenerator) Generate() (*ProjectDoc, error) + func (dg *DocGenerator) InferDescription(projectDir string) string + type DocResult struct + Content string + Relevance float64 + Source string + Title string + Tokens int + URL string + type DocSection struct + Children []DocSection + Content string + Level int + Title string + type DocSource struct + BaseURL string + Language string + Name string + Packages []string + Priority int + type DocUpdate struct + File string + Line int + NewDoc string + OldDoc string + Reason string + Symbol string + type DocUpdater struct + func NewDocUpdater() *DocUpdater + func (du *DocUpdater) ApplyUpdates(updates []DocUpdate, content string) string + func (du *DocUpdater) DetectStaleDocumentation(file, oldContent, newContent string) []DocUpdate + func (du *DocUpdater) FormatUpdates(updates []DocUpdate) string + func (du *DocUpdater) GenerateDocUpdate(funcName, signature, oldDoc string) string + func (du *DocUpdater) ScanProjectForStaleDocs(projectDir string) []DocUpdate + type ExternalDocs struct + Cache map[string]*DocResult + MaxTokens int + Sources []DocSource + func NewExternalDocs() *ExternalDocs + func (ed *ExternalDocs) BuildDocContext(results []DocResult, budget int) string + func (ed *ExternalDocs) ExtractPackageRefs(text string) []string + func (ed *ExternalDocs) FindRelevant(task string, language string, limit int) []DocResult + func (ed *ExternalDocs) FormatResults(results []DocResult) string + func (ed *ExternalDocs) RegisterSource(source DocSource) + type FieldDoc struct + Desc string + Name string + Tag string + Type string + type FunctionDoc struct + Description string + Example string + Exported bool + Name string + Parameters []ParamDoc + Returns string + Signature string + type PackageDoc struct + Description string + FileCount int + Functions []FunctionDoc + Name string + Path string + Types []TypeDoc + type ParamDoc struct + Desc string + Name string + Type string + type ProjectDoc struct + Architecture string + Description string + GeneratedAt time.Time + Name string + Packages []PackageDoc + QuickStart string + type TypeDoc struct + Description string + Fields []FieldDoc + Kind string + Methods []FunctionDoc + Name string
Go to main page