Joutsen.ArgumentsParsing v0.3.0+1-ga4c84ed
Public Member Functions | Properties | List of all members
Joutsen.ArgumentsParsing.DisplayHelpException Class Reference

An exception that writes usage and descriptions to the console. More...

Public Member Functions

 DisplayHelpException (ArgumentsParser parser)
 Creates a new instance for a parser. More...
 
- Public Member Functions inherited from Joutsen.ArgumentsParsing.DisplayException
 DisplayException (String text)
 
- Public Member Functions inherited from Joutsen.ArgumentsParsing.WritableException
 WritableException (string message, Exception innerException)
 Creates an instance with an error message and an exception that is the cause for this exception to be raised. More...
 
 WritableException (string message)
 Creates an instance with an error message. More...
 
 WritableException ()
 Creates an empty exception. More...
 
void Write (Stream stream, Encoding encoding=null)
 Writes the errror message of this exception to a stream. More...
 
void Write (TextWriter writer)
 Writes the error message of this exception using a TextWriter. More...
 
void Write ()
 Writes the error message of this exception to stdout. More...
 

Properties

override string Message [get]
 The help message to write. More...
 

Detailed Description

An exception that writes usage and descriptions to the console.

Since
0.1.0

Constructor & Destructor Documentation

◆ DisplayHelpException()

Joutsen.ArgumentsParsing.DisplayHelpException.DisplayHelpException ( ArgumentsParser  parser)

Creates a new instance for a parser.

Property Documentation

◆ Message

override string Joutsen.ArgumentsParsing.DisplayHelpException.Message
get

The help message to write.