---

CmdLineAnnotation Class Reference

A annotation for some command line arguments. More...

#include <Option.h>

Inheritance diagram for rs::cmdline::CmdLineAnnotation:

[legend]Collaboration diagram for CmdLineAnnotation:

[legend]List of all members.

Public Methods
	CmdLineAnnotation (const char *helptext_="", bool spaced_=false)
	Declare a new annotation for command line options. More...
virtual	~CmdLineAnnotation ()
Protected Methods
int	get_print_infrontof_option () const
bool	print_spaced () const
Private Attributes
int	print_infrontof_option
bool	spaced
Friends
class	ProgramInfo

---

Detailed Description

A annotation for some command line arguments.

Definition at line 429 of file Option.h.

---

Constructor & Destructor Documentation

CmdLineAnnotation (  const char *    helptext_ = "", bool    spaced_ = false )

Declare a new annotation for command line options. The annotation will be printed inbetween the two options it is declared inbetween. Annotations are printed over the full width of the current block. Use them for more detailed descriptions of how sth works. Parameters: helptext_  The text of the annotation. spaced_  Insert empty lines before and after the CmdLineAnnotation Definition at line 146 of file Option.cpp.

virtual ~CmdLineAnnotation (    )  [inline, virtual]

Definition at line 445 of file Option.h.

---

Member Function Documentation

int get_print_infrontof_option (    )  const [inline, protected]

Definition at line 449 of file Option.h.

bool print_spaced (    )  const [inline, protected]

Definition at line 450 of file Option.h.

---

Friends And Related Function Documentation

friend class ProgramInfo [friend]

Definition at line 448 of file Option.h.

---

Member Data Documentation

int print_infrontof_option [private]

Definition at line 431 of file Option.h. Referenced by CmdLineAnnotation::CmdLineAnnotation().

bool spaced [private]

Definition at line 432 of file Option.h. Referenced by CmdLineAnnotation::CmdLineAnnotation().

---

The documentation for this class was generated from the following files:

• Option.h
• Option.cpp

---

Contact me in case of errors or questions. This documentation is powered by .

(C) 2000-2002