jaster.cli.helptext

Utilities for creating help text.

Members

Aliases

ArgIsOptional
alias ArgIsOptional = Flag!"isOptional"

Undocumented in source.

AutoAddArgDashes
alias AutoAddArgDashes = Flag!"addArgDashes"

A flag that should be used by content classes that have the ability to auto add argument dashes to arg names. (e.g. "-" and "--")

Classes

HelpSectionArgInfoContent
class HelpSectionArgInfoContent

A content class for displaying information about a command line argument.

HelpSectionTextContent
class HelpSectionTextContent

A simple content class the simply displays a given string.

HelpTextBuilderSimple
class HelpTextBuilderSimple

A simpler version of HelpTextBuilerTechnical, as it has a fixed layout, and handles all of the section and content generation.

HelpTextBuilderTechnical
class HelpTextBuilderTechnical

A class used to create help text, in an object oriented fashion.

Interfaces

IHelpSectionContent
interface IHelpSectionContent

The interface for any class that can be used to generate content inside of a help text section.

Structs

HelpSection
struct HelpSection

A help text section.

HelpSectionOptions
struct HelpSectionOptions

Options on how the text of a section is formatted.

Meta