Help us shape the future of Go! Take the 2026 Go Developer Survey

gendoc

package
v0.46.2 Latest Latest
Warning

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

Go to latest
Published: Aug 1, 2025 License: GPL-3.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Command

func Command(rootCmd *cobra.Command, opts Options) *cobra.Command

Command returns command which generates user documentation for the argument.

Types

type Options added in v0.37.0

type Options struct {
	// Parameters for man generation. By default use (1) section and `FrostFS` source.
	ManHeader *doc.GenManHeader
	// TypeFlag is the flag to use for type, without leading `--`.
	// Do not use unless really necessary.
	// Default: `type`.
	TypeFlag string
	// DepthFlag is the flag to use for depth, without leading `--`.
	// Do not use unless really necessary.
	// Default: `depth`.
	DepthFlag string
	// ExtensionFlag is the flag to use for extension, without leading `--`.
	// Do not use unless really necessary.
	// Default: `extension`.
	ExtensionFlag string
}

Options for doc generation.

Jump to

Keyboard shortcuts

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