cuberite/TCLAP
1
0
Fork 0
mirror of https://github.com/cuberite/TCLAP.git synced 2025-08-04 10:16:41 -04:00
Code Issues Packages Projects Releases Wiki Activity

updated docs to reflect that Output must handle the exit rather than the CmdLine object

Browse Source
This commit is contained in:
mes5k 2006-11-26 18:42:51 +00:00
parent 6b2cb3ab1d
commit 7f430ddf5c
3 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/README
View File

@ -2,4 +2,4 @@
To generate the manual from the docbook xml you need and xslt processor To generate the manual from the docbook xml you need and xslt processor
and an xsl file that defines the output. For example: and an xsl file that defines the output. For example:
xsltproc --stringparam html.stylesheet style.css /usr/share/sgml/docbook/xsl-stylesheets-1.61.3/xhtml/docbook.xsl manual.xml > manual.html xsltproc --stringparam html.stylesheet style.css /Users/mes/software/docbook-xsl-1.71.1/xhtml/docbook.xsl manual.xml > manual.html

5
docs/manual.html
View File

@ -615,6 +615,7 @@ class MyOutput : public StdOutput
{ {
cerr << "My special failure message for: " << endl cerr << "My special failure message for: " << endl
<< e.what() << endl; << e.what() << endl;
exit(1);
} }
virtual void usage(CmdLineInterface& c) virtual void usage(CmdLineInterface& c)
@ -647,7 +648,9 @@ See <code class="filename">test4.cpp</code> in the examples directory for the fu
example. <span class="emphasis"><em>NOTE</em></span>: if you supply your own Output object, we example. <span class="emphasis"><em>NOTE</em></span>: if you supply your own Output object, we
will not delete it in the <code class="classname">CmdLine</code> destructor. This will not delete it in the <code class="classname">CmdLine</code> destructor. This
could lead to a (very small) memory leak if you don't take care of the object could lead to a (very small) memory leak if you don't take care of the object
yourself. yourself. Also note that the <code class="methodname">failure</code> method is
now responsible for exiting the application (assuming that is the desired
behavior).
</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="NO_HELP_VERSION"></a>I don't want the --help and --version switches to be created automatically...</h2></div></div></div><p> </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="NO_HELP_VERSION"></a>I don't want the --help and --version switches to be created automatically...</h2></div></div></div><p>
Help and version information is useful for nearly all command line applications Help and version information is useful for nearly all command line applications
and as such we generate flags that provide those options automatically. and as such we generate flags that provide those options automatically.

5
docs/manual.xml
View File

@ -800,6 +800,7 @@ class MyOutput : public StdOutput
{ {
cerr &lt;&lt; "My special failure message for: " &lt;&lt; endl cerr &lt;&lt; "My special failure message for: " &lt;&lt; endl
&lt;&lt; e.what() &lt;&lt; endl; &lt;&lt; e.what() &lt;&lt; endl;
exit(1);
} }
virtual void usage(CmdLineInterface&amp; c) virtual void usage(CmdLineInterface&amp; c)
@ -832,7 +833,9 @@ See <filename>test4.cpp</filename> in the examples directory for the full
example. <emphasis>NOTE</emphasis>: if you supply your own Output object, we example. <emphasis>NOTE</emphasis>: if you supply your own Output object, we
will not delete it in the <classname>CmdLine</classname> destructor. This will not delete it in the <classname>CmdLine</classname> destructor. This
could lead to a (very small) memory leak if you don't take care of the object could lead to a (very small) memory leak if you don't take care of the object
yourself. yourself. Also note that the <methodname>failure</methodname> method is
now responsible for exiting the application (assuming that is the desired
behavior).
</para> </para>
</sect1> </sect1>
<sect1 id="NO_HELP_VERSION"> <sect1 id="NO_HELP_VERSION">