Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateMarkdown ¶
GenerateMarkdown generates markdown documentation.
Types ¶
type DocEntry ¶
type DocEntry struct {
Package string `json:"package"`
Name string `json:"name"`
Type string `json:"type"` // function, type, method, variable
Doc string `json:"doc"`
File string `json:"file"`
Line int `json:"line"`
}
DocEntry represents a generated documentation entry.
type MagicDocFile ¶
MagicDocFile represents a file containing auto-update markers.
func ScanForMagicDocs ¶
func ScanForMagicDocs(dir string) []MagicDocFile
ScanForMagicDocs finds files containing "# MAGIC DOC:" markers in the given directory tree. It skips hidden directories and common non-source paths.
func (*MagicDocFile) GenerateUpdatePrompt ¶
func (m *MagicDocFile) GenerateUpdatePrompt() string
GenerateUpdatePrompt creates the prompt for the LLM to regenerate the doc.
func (*MagicDocFile) NeedsUpdate ¶
func (m *MagicDocFile) NeedsUpdate() bool
NeedsUpdate returns true if the magic doc is stale (>24h since last update).
Click to show internal directories.
Click to hide internal directories.