Legend

Class
Struct
Enum
Interface
Delegate
Constructor
Method
Property
Event
Field

Class: RT.CommandLine.DocumentationEggsMLAttribute

Summary

Use this attribute to link a command-line option or command with the help text that describes (documents) it. Suitable for single-language applications only. The documentation is to be specified in EggsML, which is interpreted as described in CommandLineParser.Colorize(EggsNode). See also DocumentationRhoMLAttribute and DocumentationAttribute.

Constructors

DocumentationEggsMLAttribute(string documentation)
Use this attribute to link a command-line option or command with the help text that describes (documents) it. Suitable for single-language applications only. The documentation is to be specified in EggsML, which is interpreted as described in CommandLineParser.Colorize(EggsNode). See also DocumentationRhoMLAttribute and DocumentationAttribute.

Instance properties

stringGets a string describing the documentation format to the programmer (not seen by the users).
stringGets the original documentation string exactly as specified in the attribute.
ConsoleColoredString Gets the console-colored documentation string. Note that this property may throw if the text couldn't be parsed where applicable.