diff options
author | Misha Brukman <brukman+llvm@gmail.com> | 2005-11-01 21:12:49 +0000 |
---|---|---|
committer | Misha Brukman <brukman+llvm@gmail.com> | 2005-11-01 21:12:49 +0000 |
commit | 2c122ceefe898fef04e86650409ec6a19a0ad19b (patch) | |
tree | 6c9396285b03e02ea84428e81376906f1c8a18de /docs/ProgrammersManual.html | |
parent | f83d406541c90511848555f853b523822f4f9c5f (diff) |
* Replace ampersands in section titles with more formal ``and''
* Surround C++ template operators with <tt>
* Add <> after templated operators for consistency
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@24144 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/ProgrammersManual.html')
-rw-r--r-- | docs/ProgrammersManual.html | 62 |
1 files changed, 32 insertions, 30 deletions
diff --git a/docs/ProgrammersManual.html b/docs/ProgrammersManual.html index e4d50039f6..1541987fdd 100644 --- a/docs/ProgrammersManual.html +++ b/docs/ProgrammersManual.html @@ -28,7 +28,7 @@ <ul> <li><a href="#isa">The <tt>isa<></tt>, <tt>cast<></tt> and <tt>dyn_cast<></tt> templates</a> </li> - <li><a href="#DEBUG">The <tt>DEBUG()</tt> macro & <tt>-debug</tt> + <li><a href="#DEBUG">The <tt>DEBUG()</tt> macro and <tt>-debug</tt> option</a> <ul> <li><a href="#DEBUG_TYPE">Fine grained debug info with <tt>DEBUG_TYPE</tt> @@ -264,7 +264,8 @@ know about when writing transformations.</p> <!-- ======================================================================= --> <div class="doc_subsection"> - <a name="isa">The isa<>, cast<> and dyn_cast<> templates</a> + <a name="isa">The <tt>isa<></tt>, <tt>cast<></tt> and + <tt>dyn_cast<></tt> templates</a> </div> <div class="doc_text"> @@ -317,44 +318,45 @@ file (note that you very rarely have to include this file directly).</p> checks to see if the operand is of the specified type, and if so, returns a pointer to it (this operator does not work with references). If the operand is not of the correct type, a null pointer is returned. Thus, this works very - much like the <tt>dynamic_cast</tt> operator in C++, and should be used in the - same circumstances. Typically, the <tt>dyn_cast<></tt> operator is used - in an <tt>if</tt> statement or some other flow control statement like this: + much like the <tt>dynamic_cast<></tt> operator in C++, and should be + used in the same circumstances. Typically, the <tt>dyn_cast<></tt> + operator is used in an <tt>if</tt> statement or some other flow control + statement like this: - <pre> + <pre> if (<a href="#AllocationInst">AllocationInst</a> *AI = dyn_cast<<a href="#AllocationInst">AllocationInst</a>>(Val)) { ... } - </pre> + </pre> - <p> This form of the <tt>if</tt> statement effectively combines together a - call to <tt>isa<></tt> and a call to <tt>cast<></tt> into one - statement, which is very convenient.</p> + <p>This form of the <tt>if</tt> statement effectively combines together a call + to <tt>isa<></tt> and a call to <tt>cast<></tt> into one + statement, which is very convenient.</p> - <p>Note that the <tt>dyn_cast<></tt> operator, like C++'s - <tt>dynamic_cast</tt> or Java's <tt>instanceof</tt> operator, can be abused. - In particular you should not use big chained <tt>if/then/else</tt> blocks to - check for lots of different variants of classes. If you find yourself - wanting to do this, it is much cleaner and more efficient to use the - <tt>InstVisitor</tt> class to dispatch over the instruction type directly.</p> + <p>Note that the <tt>dyn_cast<></tt> operator, like C++'s + <tt>dynamic_cast<></tt> or Java's <tt>instanceof</tt> operator, can be + abused. In particular, you should not use big chained <tt>if/then/else</tt> + blocks to check for lots of different variants of classes. If you find + yourself wanting to do this, it is much cleaner and more efficient to use the + <tt>InstVisitor</tt> class to dispatch over the instruction type directly.</p> - </dd> + </dd> - <dt><tt>cast_or_null<></tt>: </dt> - - <dd>The <tt>cast_or_null<></tt> operator works just like the - <tt>cast<></tt> operator, except that it allows for a null pointer as - an argument (which it then propagates). This can sometimes be useful, - allowing you to combine several null checks into one.</dd> + <dt><tt>cast_or_null<></tt>: </dt> + + <dd>The <tt>cast_or_null<></tt> operator works just like the + <tt>cast<></tt> operator, except that it allows for a null pointer as an + argument (which it then propagates). This can sometimes be useful, allowing + you to combine several null checks into one.</dd> - <dt><tt>dyn_cast_or_null<></tt>: </dt> + <dt><tt>dyn_cast_or_null<></tt>: </dt> - <dd>The <tt>dyn_cast_or_null<></tt> operator works just like the - <tt>dyn_cast<></tt> operator, except that it allows for a null pointer - as an argument (which it then propagates). This can sometimes be useful, - allowing you to combine several null checks into one.</dd> + <dd>The <tt>dyn_cast_or_null<></tt> operator works just like the + <tt>dyn_cast<></tt> operator, except that it allows for a null pointer + as an argument (which it then propagates). This can sometimes be useful, + allowing you to combine several null checks into one.</dd> - </dl> +</dl> <p>These five templates can be used with any classes, whether they have a v-table or not. To add support for these templates, you simply need to add @@ -366,7 +368,7 @@ are lots of examples in the LLVM source base.</p> <!-- ======================================================================= --> <div class="doc_subsection"> - <a name="DEBUG">The <tt>DEBUG()</tt> macro & <tt>-debug</tt> option</a> + <a name="DEBUG">The <tt>DEBUG()</tt> macro and <tt>-debug</tt> option</a> </div> <div class="doc_text"> |