Class: RT.CommandLine.DocumentationEggsMLAttribute

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

  • RT.CommandLine.DocumentationAttribute
    • System.Attribute
      • object
• Show implemented interfaces...
  Implements:

  • System.Runtime.InteropServices._Attribute
• Show derived types...
  Derived types:

  • RT.CommandLine.DocumentationLiteralAttribute

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)

Constructor.

Instance properties

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