docgen

package

v0.20.3 Latest Latest Go to latest Published: Aug 27, 2021 License: Apache-2.0 Imports: 17 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func GenerateAndWriteFiles(docGenerator *DocsGen) error

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

DEPRECATED prefer GenerateAndWriteFiles

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

write docs that are produced from the content of multiple projects

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

Hugo docs require a datafile that is used by shortcodes

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

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

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

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)

func (d *DocsGen) WriteFiles(files code_generator.Files) error