doc

package
v0.0.0-...-dfc9681 Latest Latest
Warning

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

Go to latest
Published: Jul 4, 2023 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Generator

type Generator struct {
	// WriteSchema tells the generator to output the JSON schema used by doc generation.
	WriteSchema bool `marker:",optional"`
	// Format specifies the output format for the documenation.  Supported types
	// are adoc (asciidoc) and md (markdown).  Defaults to adoc.
	Format string `marker:",optional"`

	// Depth specifies the number of levels to include in the main page.  Definitions
	// at greater depth are moved to their own pages
	Depth *int `marker:",optional"`
	// contains filtered or unexported fields
}

Generator generates documentation from kinds.

func (Generator) CheckFilter

func (Generator) CheckFilter() loader.NodeFilter

func (Generator) Generate

func (g Generator) Generate(ctx *genall.GenerationContext) error

func (Generator) RegisterMarkers

func (Generator) RegisterMarkers(into *markers.Registry) error

Jump to

Keyboard shortcuts

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