doxygen/xml/classcmd2_1_1OptionParser.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.7.5.1">
  <compounddef id="classcmd2_1_1OptionParser" kind="class" prot="public">
    <compoundname>cmd2::OptionParser</compoundname>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classcmd2_1_1OptionParser_1ada4f39b453e033ae4356709f8ee9f340" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>def</type>
        <definition>def cmd2::OptionParser::error</definition>
        <argsstring></argsstring>
        <name>error</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><verbatim>error(msg : string)

Print a usage message incorporating &apos;msg&apos; to stderr and exit.
If you override this in a subclass, it should not return -- it
should either exit or raise an exception.
</verbatim> </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="77" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="77" bodyend="85"/>
      </memberdef>
      <memberdef kind="function" id="classcmd2_1_1OptionParser_1ad82c8fb7559af2e4b1663e0762a80c89" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>def</type>
        <definition>def cmd2::OptionParser::exit</definition>
        <argsstring></argsstring>
        <name>exit</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="65" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="65" bodyend="69"/>
      </memberdef>
      <memberdef kind="function" id="classcmd2_1_1OptionParser_1a6f2d24051471268be245221149bc9c6a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>def</type>
        <definition>def cmd2::OptionParser::print_help</definition>
        <argsstring></argsstring>
        <name>print_help</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="70" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="70" bodyend="76"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="65" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="64" bodyend="86"/>
    <listofallmembers>
      <member refid="classcmd2_1_1OptionParser_1ada4f39b453e033ae4356709f8ee9f340" prot="public" virt="non-virtual"><scope>cmd2::OptionParser</scope><name>error</name></member>
      <member refid="classcmd2_1_1OptionParser_1ad82c8fb7559af2e4b1663e0762a80c89" prot="public" virt="non-virtual"><scope>cmd2::OptionParser</scope><name>exit</name></member>
      <member refid="classcmd2_1_1OptionParser_1a6f2d24051471268be245221149bc9c6a" prot="public" virt="non-virtual"><scope>cmd2::OptionParser</scope><name>print_help</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>