Class: RT.CommandLine.DocumentationEggsMLAttribute

• Assembly: RT.CommandLine, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null
• Namespace: RT.CommandLine
• Show inherited types...
  Inherits from:

  • RT.CommandLine.DocumentationAttribute
    • System.Attribute
      • object
• Show derived types...
  Derived types:

  • RT.CommandLine.DocumentationLiteralAttribute

Summary

Use this attribute to write the help text that describes (documents) a command-line option or command. Specifying multiple strings will create multiple columns in the table. The documentation is to be specified in EggsML, which is interpreted as described in CommandLineParser.Colorize(EggsNode).

Constructors

DocumentationEggsMLAttribute(params string[] documentation)

Use this attribute to write the help text that describes (documents) a command-line option or command. Specifying multiple strings will create multiple columns in the table. The documentation is to be specified in EggsML, which is interpreted as described in CommandLineParser.Colorize(EggsNode).

Instance properties

string	OriginalFormat Overrides: DocumentationAttribute.OriginalFormat	Gets a string describing the documentation format to the programmer (not seen by the users).
ConsoleColoredString[]	Texts Overrides: DocumentationAttribute.Texts	Gets the console-colored documentation string. Note that this property may throw if the text couldn't be parsed where applicable.