summaryrefslogtreecommitdiff
path: root/doxygen/xml/classcmd2_1_1OutputTrap.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doxygen/xml/classcmd2_1_1OutputTrap.xml')
-rw-r--r--doxygen/xml/classcmd2_1_1OutputTrap.xml136
1 files changed, 136 insertions, 0 deletions
diff --git a/doxygen/xml/classcmd2_1_1OutputTrap.xml b/doxygen/xml/classcmd2_1_1OutputTrap.xml
new file mode 100644
index 0000000..c5ee0c3
--- /dev/null
+++ b/doxygen/xml/classcmd2_1_1OutputTrap.xml
@@ -0,0 +1,136 @@
+<?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_1OutputTrap" kind="class" prot="public">
+ <compoundname>cmd2::OutputTrap</compoundname>
+ <basecompoundref refid="classcmd2_1_1Borg" prot="public" virt="non-virtual">cmd2::Borg</basecompoundref>
+ <sectiondef kind="public-attrib">
+ <memberdef kind="variable" id="classcmd2_1_1OutputTrap_1a9117a6d5bfa07f1eeade54f24eeba0ed" prot="public" static="no" mutable="no">
+ <type></type>
+ <definition>cmd2::OutputTrap::contents</definition>
+ <argsstring></argsstring>
+ <name>contents</name>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+ </detaileddescription>
+ <inbodydescription>
+ </inbodydescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1462" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1462" bodyend="-1"/>
+ <referencedby refid="classcmd2_1_1OutputTrap_1a492ceb8dfb3f6e90bf095a710ab56ad1" compoundref="cmd2_8py" startline="1468" endline="1471">read</referencedby>
+ <referencedby refid="classcmd2_1_1OutputTrap_1a06961b49c3e19e9984f077a08b3a75f2" compoundref="cmd2_8py" startline="1472" endline="1475">tearDown</referencedby>
+ <referencedby refid="classcmd2_1_1OutputTrap_1aa3bec468fdc0d248cd43cb8e8e0d96cd" compoundref="cmd2_8py" startline="1466" endline="1467">write</referencedby>
+ </memberdef>
+ <memberdef kind="variable" id="classcmd2_1_1OutputTrap_1ac7a0b848dc18c74b089bc0d4044996de" prot="public" static="no" mutable="no">
+ <type></type>
+ <definition>cmd2::OutputTrap::old_stdout</definition>
+ <argsstring></argsstring>
+ <name>old_stdout</name>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+ </detaileddescription>
+ <inbodydescription>
+ </inbodydescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1462" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1462" bodyend="-1"/>
+ <referencedby refid="classcmd2_1_1OutputTrap_1a06961b49c3e19e9984f077a08b3a75f2" compoundref="cmd2_8py" startline="1472" endline="1475">tearDown</referencedby>
+ </memberdef>
+ </sectiondef>
+ <sectiondef kind="public-func">
+ <memberdef kind="function" id="classcmd2_1_1OutputTrap_1a0dc45d536432b07d7ec32da5755b5c85" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+ <type>def</type>
+ <definition>def cmd2::OutputTrap::__init__</definition>
+ <argsstring></argsstring>
+ <name>__init__</name>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+ </detaileddescription>
+ <inbodydescription>
+ </inbodydescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1462" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1462" bodyend="1465"/>
+ </memberdef>
+ <memberdef kind="function" id="classcmd2_1_1OutputTrap_1a492ceb8dfb3f6e90bf095a710ab56ad1" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+ <type>def</type>
+ <definition>def cmd2::OutputTrap::read</definition>
+ <argsstring></argsstring>
+ <name>read</name>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+ </detaileddescription>
+ <inbodydescription>
+ </inbodydescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1468" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1468" bodyend="1471"/>
+ <references refid="classcmd2_1_1OutputTrap_1a9117a6d5bfa07f1eeade54f24eeba0ed" compoundref="cmd2_8py" startline="1462">contents</references>
+ </memberdef>
+ <memberdef kind="function" id="classcmd2_1_1OutputTrap_1a06961b49c3e19e9984f077a08b3a75f2" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+ <type>def</type>
+ <definition>def cmd2::OutputTrap::tearDown</definition>
+ <argsstring></argsstring>
+ <name>tearDown</name>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+ </detaileddescription>
+ <inbodydescription>
+ </inbodydescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1472" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1472" bodyend="1475"/>
+ <references refid="classcmd2_1_1OutputTrap_1a9117a6d5bfa07f1eeade54f24eeba0ed" compoundref="cmd2_8py" startline="1462">contents</references>
+ <references refid="classcmd2_1_1OutputTrap_1ac7a0b848dc18c74b089bc0d4044996de" compoundref="cmd2_8py" startline="1462">old_stdout</references>
+ </memberdef>
+ <memberdef kind="function" id="classcmd2_1_1OutputTrap_1aa3bec468fdc0d248cd43cb8e8e0d96cd" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+ <type>def</type>
+ <definition>def cmd2::OutputTrap::write</definition>
+ <argsstring></argsstring>
+ <name>write</name>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+ </detaileddescription>
+ <inbodydescription>
+ </inbodydescription>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1466" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1466" bodyend="1467"/>
+ <references refid="classcmd2_1_1OutputTrap_1a9117a6d5bfa07f1eeade54f24eeba0ed" compoundref="cmd2_8py" startline="1462">contents</references>
+ </memberdef>
+ </sectiondef>
+ <briefdescription>
+ </briefdescription>
+ <detaileddescription>
+<para><verbatim>Instantiate an OutputTrap to divert/capture ALL stdout output. For use in unit testing.
+Call `tearDown()` to return to normal output.</verbatim> </para> </detaileddescription>
+ <inheritancegraph>
+ <node id="24">
+ <label>cmd2::Borg</label>
+ <link refid="classcmd2_1_1Borg"/>
+ </node>
+ <node id="23">
+ <label>cmd2::OutputTrap</label>
+ <link refid="classcmd2_1_1OutputTrap"/>
+ <childnode refid="24" relation="public-inheritance">
+ </childnode>
+ </node>
+ </inheritancegraph>
+ <collaborationgraph>
+ <node id="26">
+ <label>cmd2::Borg</label>
+ <link refid="classcmd2_1_1Borg"/>
+ </node>
+ <node id="25">
+ <label>cmd2::OutputTrap</label>
+ <link refid="classcmd2_1_1OutputTrap"/>
+ <childnode refid="26" relation="public-inheritance">
+ </childnode>
+ </node>
+ </collaborationgraph>
+ <location file="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" line="1461" bodyfile="/Users/amrogers/Developer/Projects/cmd2/cmd2.py" bodystart="1459" bodyend="1476"/>
+ <listofallmembers>
+ <member refid="classcmd2_1_1OutputTrap_1a0dc45d536432b07d7ec32da5755b5c85" prot="public" virt="non-virtual"><scope>cmd2::OutputTrap</scope><name>__init__</name></member>
+ <member refid="classcmd2_1_1Borg_1addff1031aaf78f5e1dc5ff0c6dba5137" prot="public" virt="non-virtual"><scope>cmd2::OutputTrap</scope><name>__new__</name></member>
+ <member refid="classcmd2_1_1OutputTrap_1a9117a6d5bfa07f1eeade54f24eeba0ed" prot="public" virt="non-virtual"><scope>cmd2::OutputTrap</scope><name>contents</name></member>
+ <member refid="classcmd2_1_1OutputTrap_1ac7a0b848dc18c74b089bc0d4044996de" prot="public" virt="non-virtual"><scope>cmd2::OutputTrap</scope><name>old_stdout</name></member>
+ <member refid="classcmd2_1_1OutputTrap_1a492ceb8dfb3f6e90bf095a710ab56ad1" prot="public" virt="non-virtual"><scope>cmd2::OutputTrap</scope><name>read</name></member>
+ <member refid="classcmd2_1_1OutputTrap_1a06961b49c3e19e9984f077a08b3a75f2" prot="public" virt="non-virtual"><scope>cmd2::OutputTrap</scope><name>tearDown</name></member>
+ <member refid="classcmd2_1_1OutputTrap_1aa3bec468fdc0d248cd43cb8e8e0d96cd" prot="public" virt="non-virtual"><scope>cmd2::OutputTrap</scope><name>write</name></member>
+ </listofallmembers>
+ </compounddef>
+</doxygen>