docs

Documentation

Index

• type DocGenerator
  • func NewDocGenerator(registry registry.PluginRegistry, logger hclog.Logger) *DocGenerator
  • func (g *DocGenerator) GenerateAllPluginDocs(outputDir string) error
  • func (g *DocGenerator) GeneratePluginDetailDoc(pluginID string) (string, error)
  • func (g *DocGenerator) GeneratePluginDiagram(outputPath string) error
  • func (g *DocGenerator) GeneratePluginListDoc() (string, error)
  • func (g *DocGenerator) LoadTemplate(name, content string) error
  • func (g *DocGenerator) LoadTemplateFromFile(name, path string) error

Types

type DocGenerator

type DocGenerator struct {
	// contains filtered or unexported fields
}

DocGenerator 文档生成器 负责生成插件文档

func NewDocGenerator

func NewDocGenerator(registry registry.PluginRegistry, logger hclog.Logger) *DocGenerator

NewDocGenerator 创建一个新的文档生成器

func (*DocGenerator) GenerateAllPluginDocs

func (g *DocGenerator) GenerateAllPluginDocs(outputDir string) error

GenerateAllPluginDocs 生成所有插件文档

func (*DocGenerator) GeneratePluginDetailDoc

func (g *DocGenerator) GeneratePluginDetailDoc(pluginID string) (string, error)

GeneratePluginDetailDoc 生成插件详情文档

func (*DocGenerator) GeneratePluginDiagram

func (g *DocGenerator) GeneratePluginDiagram(outputPath string) error

GeneratePluginDiagram 生成插件依赖关系图

func (*DocGenerator) GeneratePluginListDoc

func (g *DocGenerator) GeneratePluginListDoc() (string, error)

GeneratePluginListDoc 生成插件列表文档

func (*DocGenerator) LoadTemplate

func (g *DocGenerator) LoadTemplate(name, content string) error

LoadTemplate 加载模板

func (*DocGenerator) LoadTemplateFromFile

func (g *DocGenerator) LoadTemplateFromFile(name, path string) error

LoadTemplateFromFile 从文件加载模板