<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/> <title>tclap: TCLAP::DocBookOutput Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.0 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceTCLAP.html">TCLAP</a>::<a class="el" href="classTCLAP_1_1DocBookOutput.html">DocBookOutput</a> </div> </div> <div class="contents"> <h1>TCLAP::DocBookOutput Class Reference</h1><!-- doxytag: class="TCLAP::DocBookOutput" --><!-- doxytag: inherits="TCLAP::CmdLineOutput" --> <p>A class that generates DocBook output for <a class="el" href="classTCLAP_1_1DocBookOutput.html#adc1ec93f3f7e5e912690be01c5e7d6e2" title="Prints the usage to stdout.">usage()</a> method for the given <a class="el" href="classTCLAP_1_1CmdLine.html" title="The base class that manages the command line definition and passes along the parsing...">CmdLine</a> and its Args. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="DocBookOutput_8h_source.html">DocBookOutput.h</a>></code></p> <div class="dynheader"> Inheritance diagram for TCLAP::DocBookOutput:</div> <div class="dynsection"> <div class="center"> <img src="classTCLAP_1_1DocBookOutput.gif" usemap="#TCLAP::DocBookOutput_map" alt=""/> <map id="TCLAP::DocBookOutput_map" name="TCLAP::DocBookOutput_map"> <area href="classTCLAP_1_1CmdLineOutput.html" alt="TCLAP::CmdLineOutput" shape="rect" coords="0,0,146,24"/> </map> </div> </div> <p><a href="classTCLAP_1_1DocBookOutput-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1DocBookOutput.html#adc1ec93f3f7e5e912690be01c5e7d6e2">usage</a> (<a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> &c)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Prints the usage to stdout. <a href="#adc1ec93f3f7e5e912690be01c5e7d6e2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1DocBookOutput.html#a3ccf7671dcae82aba5f0e91850ae25a4">version</a> (<a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> &c)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Prints the version to stdout. <a href="#a3ccf7671dcae82aba5f0e91850ae25a4"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1DocBookOutput.html#a5e97f659fa1ab3b060a31e8bd7a0a40e">failure</a> (<a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> &c, <a class="el" href="classTCLAP_1_1ArgException.html">ArgException</a> &e)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior. <a href="#a5e97f659fa1ab3b060a31e8bd7a0a40e"></a><br/></td></tr> <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1DocBookOutput.html#a7546eaf3a0effeea1030afb27b4c698f">substituteSpecialChars</a> (std::string &s, char r, std::string &x)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Substitutes the char r for string x in string s. <a href="#a7546eaf3a0effeea1030afb27b4c698f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1DocBookOutput.html#abc059536cb97c49da4e6c5b4a22c6cef">removeChar</a> (std::string &s, char r)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1DocBookOutput.html#a82d49ab25845c7d191863be9c482409e">basename</a> (std::string &s)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1DocBookOutput.html#a980ecacfcda0186a76bb6c37a9c33726">printShortArg</a> (<a class="el" href="classTCLAP_1_1Arg.html">Arg</a> *it)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1DocBookOutput.html#a891cf5ef71592b5261691575c2adad1d">printLongArg</a> (<a class="el" href="classTCLAP_1_1Arg.html">Arg</a> *it)</td></tr> <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1DocBookOutput.html#a081a02a93ce13f694d078c79fe42a7c8">theDelimiter</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>A class that generates DocBook output for <a class="el" href="classTCLAP_1_1DocBookOutput.html#adc1ec93f3f7e5e912690be01c5e7d6e2" title="Prints the usage to stdout.">usage()</a> method for the given <a class="el" href="classTCLAP_1_1CmdLine.html" title="The base class that manages the command line definition and passes along the parsing...">CmdLine</a> and its Args. </p> <p>Definition at line <a class="el" href="DocBookOutput_8h_source.html#l00043">43</a> of file <a class="el" href="DocBookOutput_8h_source.html">DocBookOutput.h</a>.</p> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a82d49ab25845c7d191863be9c482409e"></a><!-- doxytag: member="TCLAP::DocBookOutput::basename" ref="a82d49ab25845c7d191863be9c482409e" args="(std::string &s)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::DocBookOutput::basename </td> <td>(</td> <td class="paramtype">std::string & </td> <td class="paramname"> <em>s</em></td> <td> ) </td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="DocBookOutput_8h_source.html#l00203">203</a> of file <a class="el" href="DocBookOutput_8h_source.html">DocBookOutput.h</a>.</p> <p>Referenced by <a class="el" href="DocBookOutput_8h_source.html#l00095">usage()</a>.</p> </div> </div> <a class="anchor" id="a5e97f659fa1ab3b060a31e8bd7a0a40e"></a><!-- doxytag: member="TCLAP::DocBookOutput::failure" ref="a5e97f659fa1ab3b060a31e8bd7a0a40e" args="(CmdLineInterface &c, ArgException &e)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::DocBookOutput::failure </td> <td>(</td> <td class="paramtype"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> & </td> <td class="paramname"> <em>c</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classTCLAP_1_1ArgException.html">ArgException</a> & </td> <td class="paramname"> <em>e</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>- The <a class="el" href="classTCLAP_1_1CmdLine.html" title="The base class that manages the command line definition and passes along the parsing...">CmdLine</a> object the output is generated for. </td></tr> <tr><td valign="top"></td><td valign="top"><em>e</em> </td><td>- The <a class="el" href="classTCLAP_1_1ArgException.html" title="A simple class that defines and argument exception.">ArgException</a> that caused the failure. </td></tr> </table> </dd> </dl> <p>Implements <a class="el" href="classTCLAP_1_1CmdLineOutput.html#ad23a57ac3d8d957a4328fc78aec94e16">TCLAP::CmdLineOutput</a>.</p> <p>Definition at line <a class="el" href="DocBookOutput_8h_source.html#l00174">174</a> of file <a class="el" href="DocBookOutput_8h_source.html">DocBookOutput.h</a>.</p> <p>References <a class="el" href="ArgException_8h_source.html#l00080">TCLAP::ArgException::what()</a>.</p> </div> </div> <a class="anchor" id="a891cf5ef71592b5261691575c2adad1d"></a><!-- doxytag: member="TCLAP::DocBookOutput::printLongArg" ref="a891cf5ef71592b5261691575c2adad1d" args="(Arg *it)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::DocBookOutput::printLongArg </td> <td>(</td> <td class="paramtype"><a class="el" href="classTCLAP_1_1Arg.html">Arg</a> * </td> <td class="paramname"> <em>it</em></td> <td> ) </td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="DocBookOutput_8h_source.html#l00252">252</a> of file <a class="el" href="DocBookOutput_8h_source.html">DocBookOutput.h</a>.</p> <p>Referenced by <a class="el" href="DocBookOutput_8h_source.html#l00095">usage()</a>.</p> </div> </div> <a class="anchor" id="a980ecacfcda0186a76bb6c37a9c33726"></a><!-- doxytag: member="TCLAP::DocBookOutput::printShortArg" ref="a980ecacfcda0186a76bb6c37a9c33726" args="(Arg *it)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::DocBookOutput::printShortArg </td> <td>(</td> <td class="paramtype"><a class="el" href="classTCLAP_1_1Arg.html">Arg</a> * </td> <td class="paramname"> <em>it</em></td> <td> ) </td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="DocBookOutput_8h_source.html#l00212">212</a> of file <a class="el" href="DocBookOutput_8h_source.html">DocBookOutput.h</a>.</p> <p>References <a class="el" href="Arg_8h_source.html#l00674">TCLAP::Arg::acceptsMultipleValues()</a>, <a class="el" href="Arg_8h_source.html#l00571">TCLAP::Arg::isRequired()</a>, <a class="el" href="DocBookOutput_8h_source.html#l00194">removeChar()</a>, <a class="el" href="Arg_8h_source.html#l00505">TCLAP::Arg::shortID()</a>, and <a class="el" href="DocBookOutput_8h_source.html#l00182">substituteSpecialChars()</a>.</p> <p>Referenced by <a class="el" href="DocBookOutput_8h_source.html#l00095">usage()</a>.</p> </div> </div> <a class="anchor" id="abc059536cb97c49da4e6c5b4a22c6cef"></a><!-- doxytag: member="TCLAP::DocBookOutput::removeChar" ref="abc059536cb97c49da4e6c5b4a22c6cef" args="(std::string &s, char r)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::DocBookOutput::removeChar </td> <td>(</td> <td class="paramtype">std::string & </td> <td class="paramname"> <em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char </td> <td class="paramname"> <em>r</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="DocBookOutput_8h_source.html#l00194">194</a> of file <a class="el" href="DocBookOutput_8h_source.html">DocBookOutput.h</a>.</p> <p>Referenced by <a class="el" href="DocBookOutput_8h_source.html#l00212">printShortArg()</a>.</p> </div> </div> <a class="anchor" id="a7546eaf3a0effeea1030afb27b4c698f"></a><!-- doxytag: member="TCLAP::DocBookOutput::substituteSpecialChars" ref="a7546eaf3a0effeea1030afb27b4c698f" args="(std::string &s, char r, std::string &x)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::DocBookOutput::substituteSpecialChars </td> <td>(</td> <td class="paramtype">std::string & </td> <td class="paramname"> <em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char </td> <td class="paramname"> <em>r</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">std::string & </td> <td class="paramname"> <em>x</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Substitutes the char r for string x in string s. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>- The string to operate on. </td></tr> <tr><td valign="top"></td><td valign="top"><em>r</em> </td><td>- The char to replace. </td></tr> <tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>- What to replace r with. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="DocBookOutput_8h_source.html#l00182">182</a> of file <a class="el" href="DocBookOutput_8h_source.html">DocBookOutput.h</a>.</p> <p>Referenced by <a class="el" href="DocBookOutput_8h_source.html#l00212">printShortArg()</a>.</p> </div> </div> <a class="anchor" id="adc1ec93f3f7e5e912690be01c5e7d6e2"></a><!-- doxytag: member="TCLAP::DocBookOutput::usage" ref="adc1ec93f3f7e5e912690be01c5e7d6e2" args="(CmdLineInterface &c)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::DocBookOutput::usage </td> <td>(</td> <td class="paramtype"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> & </td> <td class="paramname"> <em>c</em></td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Prints the usage to stdout. </p> <p>Can be overridden to produce alternative behavior. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>- The <a class="el" href="classTCLAP_1_1CmdLine.html" title="The base class that manages the command line definition and passes along the parsing...">CmdLine</a> object the output is generated for. </td></tr> </table> </dd> </dl> <p>Implements <a class="el" href="classTCLAP_1_1CmdLineOutput.html#a685b13db5bf6bbe5159e49169cd96bbe">TCLAP::CmdLineOutput</a>.</p> <p>Definition at line <a class="el" href="DocBookOutput_8h_source.html#l00095">95</a> of file <a class="el" href="DocBookOutput_8h_source.html">DocBookOutput.h</a>.</p> <p>References <a class="el" href="DocBookOutput_8h_source.html#l00203">basename()</a>, <a class="el" href="XorHandler_8h_source.html#l00141">TCLAP::XorHandler::contains()</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a4de8d988f5a6f3007c4dfb0fc9dad476">TCLAP::CmdLineInterface::getArgList()</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a7d6a64cff6b3a30e2cf1e81d7b1d4521">TCLAP::CmdLineInterface::getDelimiter()</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a30175a2567f7ab78a2c6bbea9269a2fa">TCLAP::CmdLineInterface::getMessage()</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a1a5672df72a6b5021cd70b37c4dbd0a7">TCLAP::CmdLineInterface::getProgramName()</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a0a552fa57212800dfb8aec84fb07b8bb">TCLAP::CmdLineInterface::getVersion()</a>, <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a11ce9c77a1111960741f05e343849e4e">TCLAP::CmdLineInterface::getXorHandler()</a>, <a class="el" href="XorHandler_8h_source.html#l00153">TCLAP::XorHandler::getXorList()</a>, <a class="el" href="DocBookOutput_8h_source.html#l00252">printLongArg()</a>, <a class="el" href="DocBookOutput_8h_source.html#l00212">printShortArg()</a>, and <a class="el" href="DocBookOutput_8h_source.html#l00086">theDelimiter</a>.</p> </div> </div> <a class="anchor" id="a3ccf7671dcae82aba5f0e91850ae25a4"></a><!-- doxytag: member="TCLAP::DocBookOutput::version" ref="a3ccf7671dcae82aba5f0e91850ae25a4" args="(CmdLineInterface &c)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCLAP::DocBookOutput::version </td> <td>(</td> <td class="paramtype"><a class="el" href="classTCLAP_1_1CmdLineInterface.html">CmdLineInterface</a> & </td> <td class="paramname"> <em>c</em></td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Prints the version to stdout. </p> <p>Can be overridden to produce alternative behavior. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>- The <a class="el" href="classTCLAP_1_1CmdLine.html" title="The base class that manages the command line definition and passes along the parsing...">CmdLine</a> object the output is generated for. </td></tr> </table> </dd> </dl> <p>Implements <a class="el" href="classTCLAP_1_1CmdLineOutput.html#ae052fea473132482296de55edb3dd480">TCLAP::CmdLineOutput</a>.</p> <p>Definition at line <a class="el" href="DocBookOutput_8h_source.html#l00090">90</a> of file <a class="el" href="DocBookOutput_8h_source.html">DocBookOutput.h</a>.</p> <p>References <a class="el" href="classTCLAP_1_1CmdLineInterface.html#a0a552fa57212800dfb8aec84fb07b8bb">TCLAP::CmdLineInterface::getVersion()</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a081a02a93ce13f694d078c79fe42a7c8"></a><!-- doxytag: member="TCLAP::DocBookOutput::theDelimiter" ref="a081a02a93ce13f694d078c79fe42a7c8" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char <a class="el" href="classTCLAP_1_1DocBookOutput.html#a081a02a93ce13f694d078c79fe42a7c8">TCLAP::DocBookOutput::theDelimiter</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="DocBookOutput_8h_source.html#l00086">86</a> of file <a class="el" href="DocBookOutput_8h_source.html">DocBookOutput.h</a>.</p> <p>Referenced by <a class="el" href="DocBookOutput_8h_source.html#l00095">usage()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="DocBookOutput_8h_source.html">DocBookOutput.h</a></li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated on Sat Apr 16 15:34:25 2011 for tclap by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.0 </small></address> </body> </html>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 16129 | tjuricek |
Rename/move files again... this time to the hyphenated-approach. |
||
//guest/tjuricek/file_system_client/main/vendor/tclap-1.2.1/docs/html/classTCLAP_1_1DocBookOutput.html | |||||
#1 | 16119 | tjuricek | Rename/move to meet workshop project conventions. | ||
//guest/tjuricek/fsclient/vendor/tclap-1.2.1/docs/html/classTCLAP_1_1DocBookOutput.html | |||||
#1 | 16118 | tjuricek |
FSClient initial version: handles add, edit This is a proof-of-concept app that mirrors an existing Perforce workspace to handle running commands like "p4 add" and "p4 edit" automatically when your apps add and write files. See the readme for more information. |