gendoc

Documentation

Index

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

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

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.