6502/llvm-6502
1
0
Fork 0
mirror of https://github.com/c64scene-ar/llvm-6502.git synced 2025-05-13 01:15:32 +00:00
Code Issues Projects Releases Wiki Activity

* Use doc_code style for blocks of code

Browse Source 
* Convert < to &lt; in <pre> block
* Use doc_hilite instead of doc_red style
* Put some classes and options in <tt> blocks


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@20100 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Misha Brukman 2005-02-09 22:49:05 +00:00
parent 0465e89a70
commit 1fc9f8ef0c
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/CommandLine.html
View File

@ -961,6 +961,7 @@ all of these clients (requiring lots of .cpp files to #include
<p>To do this, set up your .h file with your option, like this for example:</p> <p>To do this, set up your .h file with your option, like this for example:</p>
<div class="doc_code">
<pre> <pre>
<i>// DebugFlag.h - Get access to the '-debug' command line option <i>// DebugFlag.h - Get access to the '-debug' command line option
// //
@ -976,15 +977,15 @@ extern bool DebugFlag;
// debug build, then the code specified as the option to the macro will be // debug build, then the code specified as the option to the macro will be
// executed. Otherwise it will not be. Example: // executed. Otherwise it will not be. Example:
// //
// DEBUG(cerr << "Bitset contains: " << Bitset << "\n"); // DEBUG(std::cerr &lt;&lt; "Bitset contains: " &lt;&lt; Bitset &lt;&lt; "\n");
//</i> //</i>
<span class="doc_red">#ifdef NDEBUG <span class="doc_hilite">#ifdef NDEBUG
#define DEBUG(X) #define DEBUG(X)
#else #else
#define DEBUG(X)</span> \ #define DEBUG(X)</span> do { if (DebugFlag) { X; } } while (0)
do { if (DebugFlag) { X; } } while (0) <span class="doc_hilite">#endif</span>
<span class="doc_red">#endif</span>
</pre> </pre>
</div>
<p>This allows clients to blissfully use the <tt>DEBUG()</tt> macro, or the <p>This allows clients to blissfully use the <tt>DEBUG()</tt> macro, or the
<tt>DebugFlag</tt> explicitly if they want to. Now we just need to be able to <tt>DebugFlag</tt> explicitly if they want to. Now we just need to be able to
@ -993,18 +994,19 @@ an additial argument to our command line argument processor, and we specify
where to fill in with the <a href="#cl::location">cl::location</a> where to fill in with the <a href="#cl::location">cl::location</a>
attribute:</p> attribute:</p>
<div class="doc_code">
<pre> <pre>
bool DebugFlag; <i>// the actual value</i> bool DebugFlag; <i>// the actual value</i>
static <a href="#cl::opt">cl::opt</a>&lt;bool, true&gt; <i>// The parser</i> static <a href="#cl::opt">cl::opt</a>&lt;bool, true&gt; <i>// The parser</i>
Debug("<i>debug</i>", <a href="#cl::desc">cl::desc</a>("<i>Enable debug output</i>"), <a href="#cl::Hidden">cl::Hidden</a>, Debug("<i>debug</i>", <a href="#cl::desc">cl::desc</a>("<i>Enable debug output</i>"), <a href="#cl::Hidden">cl::Hidden</a>, <a href="#cl::location">cl::location</a>(DebugFlag));
<a href="#cl::location">cl::location</a>(DebugFlag));
</pre> </pre>
</div>
<p>In the above example, we specify "<tt>true</tt>" as the second argument to <p>In the above example, we specify "<tt>true</tt>" as the second argument to
the <a href="#cl::opt">cl::opt</a> template, indicating that the template should the <tt><a href="#cl::opt">cl::opt</a></tt> template, indicating that the
not maintain a copy of the value itself. In addition to this, we specify the <a template should not maintain a copy of the value itself. In addition to this,
href="#cl::location">cl::location</a> attribute, so that <tt>DebugFlag</tt> is we specify the <tt><a href="#cl::location">cl::location</a></tt> attribute, so
automatically set.</p> that <tt>DebugFlag</tt> is automatically set.</p>
</div> </div>
@ -1055,8 +1057,8 @@ the section on <a href="#storage">Internal vs External Storage</a> for more
information.</li> information.</li>
<li><a name="cl::aliasopt">The <b><tt>cl::aliasopt</tt></b></a> attribute <li><a name="cl::aliasopt">The <b><tt>cl::aliasopt</tt></b></a> attribute
specifies which option a <a href="#cl::alias">cl::alias</a> option is an alias specifies which option a <tt><a href="#cl::alias">cl::alias</a></tt> option is
for.</li> an alias for.</li>
<li><a name="cl::values">The <b><tt>cl::values</tt></b></a> attribute specifies <li><a name="cl::values">The <b><tt>cl::values</tt></b></a> attribute specifies
the string-to-value mapping to be used by the generic parser. It takes a the string-to-value mapping to be used by the generic parser. It takes a