Class: RT.CommandLine.DocumentationAttribute

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

  • System.Attribute
    • object
• Show implemented interfaces...
  Implements:

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

  • RT.CommandLine.DocumentationEggsMLAttribute
  • RT.CommandLine.DocumentationRhoMLAttribute

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. See Remarks.

Remarks

This attribute specifies the documentation in plain text. All characters are printed exactly as specified. You may wish to use DocumentationRhoMLAttribute to specify documentation with special markup for command-line-related concepts, as well as DocumentationEggsMLAttribute for an alternative markup language without command-line specific concepts.

Constructors

DocumentationAttribute(string documentation)

Constructor.

Instance properties

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