Versions in this module Expand all Collapse all v0 v0.3.0 Jan 10, 2023 Changes in this version + var ErrMissingCommandName = errors.New("you need a command name to have a man page") + type Options struct + Author string + Bugs string + CenterFooter string + CenterHeader string + CustomData map[string]interface{} + Date *time.Time + Environment string + Files string + LeftFooter string + Section string v0.2.0 Jul 28, 2022 Changes in this version type CobraManOptions + CustomData map[string]interface{} v0.1.0 Jul 28, 2022 Changes in this version + func AddTemplateFunc(name string, tmplFunc interface{}) + func AddTemplateFuncs(tmplFuncs template.FuncMap) + func GenerateDocs(cmd *cobra.Command, opts *CobraManOptions, directory string, ...) error + func GenerateOnePage(cmd *cobra.Command, opts *CobraManOptions, templateName string, w io.Writer) error + func RegisterTemplate(name string, separator string, extension string, templateString string) + type CobraManOptions struct + Author string + Bugs string + CenterFooter string + CenterHeader string + Date *time.Time + Environment string + Files string + LeftFooter string + Section string + type DocGenTool struct + func CreateDocGenCmdLineTool(appCmd *cobra.Command) *DocGenTool + func (dg *DocGenTool) AddBashCompletionGenerator(fileName string) *DocGenTool + func (dg *DocGenTool) AddDocGenerator(opts *CobraManOptions, templateName string) *DocGenTool + func (dg *DocGenTool) Execute() error
Go to main page