Package cmdline

import "gitlab.com/zoralab/godocgen/api/cmdline"

Package cmdline is the command line API for Godocgen.

This is for other Go command application to have Godocgen's compatible command line interfaces (CLI).

CMD

type CMD struct {
	// contains filtered or unexported fields
}

CMD is the API structure for running godocgen command line interface API

It is safe to create CMD object using the conventional &CMD{} method.

Func (cmd *CMD) ParseArgs()

ParseArgs is the command line interface arguments processor.

It processes all the necessary arguments before executing App.Run(). This function also holds the command lines parameters descriptions for Godocgen program.

ParseArgs reads from os.Args, via ZORALab's Cerigo's os/args library.