commanddocgenerator

Documentation

Index

• func GenerateBookYAML(buf *bytes.Buffer, cmd *cobra.Command, docVersion string)
• func ListHeritage(cmd *cobra.Command) []string
• func PrintFlags(buf *bytes.Buffer, flagSet *pflag.FlagSet)
• func TraverseCommands(cmd *cobra.Command, f func(cmd *cobra.Command) error) error

Functions

func GenerateBookYAML

func GenerateBookYAML(buf *bytes.Buffer, cmd *cobra.Command, docVersion string)

GenerateBookYAML generates the _book.yaml. See https://developers.google.com/devsite/reference/metadata/book

func ListHeritage

func ListHeritage(cmd *cobra.Command) []string

ListHeritage returns a slice of names representing the heritage of a command.

func PrintFlags

func PrintFlags(buf *bytes.Buffer, flagSet *pflag.FlagSet)

PrintFlags converts the flagSet to a GCP docs compatible format.

func TraverseCommands

func TraverseCommands(cmd *cobra.Command, f func(cmd *cobra.Command) error) error

TraverseCommands will invoke the given function for each command that is not hidden or only a help topic.