diff options
| author | Reid Spencer <rspencer@reidspencer.com> | 2006-06-05 17:30:16 +0000 |
|---|---|---|
| committer | Reid Spencer <rspencer@reidspencer.com> | 2006-06-05 17:30:16 +0000 |
| commit | 2403b855cdd42db799052b30b286095d731f7646 (patch) | |
| tree | 94390201df0eb44aa6b2afc6a5711b1d72d3ee4c /docs/CommandLine.html | |
| parent | bddcb9427cb36ac6609fef233eaac3c9b5e5a8f4 (diff) | |
| download | external_llvm-2403b855cdd42db799052b30b286095d731f7646.zip external_llvm-2403b855cdd42db799052b30b286095d731f7646.tar.gz external_llvm-2403b855cdd42db799052b30b286095d731f7646.tar.bz2 | |
Document the cl::SetVersionPrinter function.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@28690 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CommandLine.html')
| -rw-r--r-- | docs/CommandLine.html | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/CommandLine.html b/docs/CommandLine.html index 7da06e8..5898bb3 100644 --- a/docs/CommandLine.html +++ b/docs/CommandLine.html @@ -60,6 +60,8 @@ <tt>cl::ParseCommandLineOptions</tt> function</a></li> <li><a href="#cl::ParseEnvironmentOptions">The <tt>cl::ParseEnvironmentOptions</tt> function</a></li> + <li><a href="#cl::SetVersionPrinter">The cl::SetVersionPrinter + function</a></li> <li><a href="#cl::opt">The <tt>cl::opt</tt> class</a></li> <li><a href="#cl::list">The <tt>cl::list</tt> class</a></li> <li><a href="#cl::bits">The <tt>cl::bits</tt> class</a></li> @@ -1507,6 +1509,27 @@ input.</p> <!-- _______________________________________________________________________ --> <div class="doc_subsubsection"> + <a name="cl::SetVersionPrinter">The <tt>cl::SetVersionPrinter</tt> + function</a> +</div> + +<div class="doc_text"> + +<p>The <tt>cl::SetVersionPrinter</tt> function is designed to be called +directly from <tt>main</tt>, and <i>before</i> +<tt>cl::ParseCommandLineOptions</tt>. Its use is optional. It simply arranges +for a function to be called in response to the <tt>--version</tt> option instead +of having the <tt>CommandLine</tt> library print out the usual version string +for LLVM. This is useful for programs that are not part of LLVM but wish to use +the <tt>CommandLine</tt> facilities. Such programs should just define a small +function that takes no arguments and returns <tt>void</tt> and that prints out +whatever version information is appropriate for the program. Pass the address +of that function to <tt>cl::SetVersionPrinter</tt> to arrange for it to be +called when the <tt>--version</tt> option is given by the user.</p> + +</div> +<!-- _______________________________________________________________________ --> +<div class="doc_subsubsection"> <a name="cl::opt">The <tt>cl::opt</tt> class</a> </div> |