doc

package

v0.0.0-...-aa76af1 Latest Latest Go to latest Published: May 17, 2024 License: Apache-2.0 Imports: 6 Imported by: 3

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 Generate(path string)

Generate plugin doc to the path/category directory.

func Register(category, name string, doc Doc)

Register the doc description to the doc center.

type Doc interface {
	Description() string
}

Doc generates markdown doc with the exported field. If some field want to add comment, please use comment tag to describe it.

type FieldConfig struct {
	Name    string
	Type    string
	Comment string
	Default string
}