docgen

Documentation

Index

• func GenerateFiles(project *model.Project, docsOptions *options.DocsOptions) (code_generator.Files, error)
• func WriteCrossProjectDocs(genDocs *options.DocsOptions, absoluteRoot string, ...) error
• func WriteCrossProjectDocsHugo(genDocs *options.DocsOptions, absoluteRoot string, ...) error
• func WritePerProjectsDocs(project *model.Project, genDocs *options.DocsOptions, absoluteRoot string) error
• type DocsGen
  • func (d *DocsGen) FileHeader(filename string) string
  • func (d *DocsGen) GenerateFilesForProject() (code_generator.Files, error)
  • func (d *DocsGen) GenerateFilesForProtoFiles(protoFiles []*protokit.FileDescriptor) (code_generator.Files, error)

Functions

func GenerateFiles

func GenerateFiles(project *model.Project, docsOptions *options.DocsOptions) (code_generator.Files, error)

func WriteCrossProjectDocs

func WriteCrossProjectDocs(
	genDocs *options.DocsOptions,
	absoluteRoot string,
	projectMap parser.ProjectMap,
) error

write docs that are produced from the content of multiple projects

func WriteCrossProjectDocsHugo

func WriteCrossProjectDocsHugo(
	genDocs *options.DocsOptions,
	absoluteRoot string,
	projectMap parser.ProjectMap,
) error

Hugo docs require a datafile that is used by shortcodes

func WritePerProjectsDocs

func WritePerProjectsDocs(project *model.Project, genDocs *options.DocsOptions, absoluteRoot string) error

write docs that are produced from the content of a single project

Types

type DocsGen

type DocsGen struct {
	DocsOptions options.DocsOptions
	Project     *model.Project
}

func (*DocsGen) FileHeader

func (d *DocsGen) FileHeader(filename string) string

func (*DocsGen) GenerateFilesForProject

func (d *DocsGen) GenerateFilesForProject() (code_generator.Files, error)

func (*DocsGen) GenerateFilesForProtoFiles

func (d *DocsGen) GenerateFilesForProtoFiles(protoFiles []*protokit.FileDescriptor) (code_generator.Files, error)