docs

Documentation

Overview

Package docs contains the logic that handle the docs command in liqoctl

Index

• Constants
• type Args
  • func (o *Args) Handler(ctx context.Context) error

Constants

const (
	// ShortHelp contains the short help string for liqoctl docs command.
	ShortHelp = "Generate documentation as markdown"
	// LongHelp contains the Long help string for liqoctl docs command.
	LongHelp = `` /* 178-byte string literal not displayed */

	// UseCommand contains the name of the command.
	UseCommand = "docs"
	// OutputDir contains the name of dir flag.
	OutputDir = "dir"
	// DocType contains the name of type flag.
	DocType = "type"
	// GenerateHeaders contains the name of generate-headers.
	GenerateHeaders = "generate-headers"
)

Types

type Args

type Args struct {
	Dest            string
	DocTypeString   string
	TopCmd          *cobra.Command
	GenerateHeaders bool
}

Args holds the necessary flags for the docs command.

func (*Args) Handler

func (o *Args) Handler(ctx context.Context) error

Handler implement the logic of the docs command.