docgen

package
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 15, 2025 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GeneratePluginDocs

func GeneratePluginDocs(pluginPath string, outputDir string) error

Types

type AdditionalSection

type AdditionalSection struct {
	Title   string
	Content string
}

type PluginDoc

type PluginDoc struct {
	Name               string
	Description        string
	ConfigDescription  string
	ConfigProperties   []PropertyDoc
	MetadataFields     []PropertyDoc
	SupportedServices  []string
	ExampleConfig      string
	Status             string
	AdditionalSections []AdditionalSection
}

type PropertyDoc

type PropertyDoc struct {
	Name        string
	Type        string
	Description string
	Required    bool
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL