diff options
| -rw-r--r-- | docs/CodingStandards.html | 34 |
1 files changed, 19 insertions, 15 deletions
diff --git a/docs/CodingStandards.html b/docs/CodingStandards.html index 2c7eeead79..a9b3698ae4 100644 --- a/docs/CodingStandards.html +++ b/docs/CodingStandards.html @@ -526,7 +526,6 @@ library. There are two problems with this:</p> example) is allowed normally, it is just <tt><iostream></tt> that is causing problems.</p> -<div align="center"> <table> <tbody> <tr> @@ -571,17 +570,22 @@ DEBUG(dump(DOUT));</pre></td> <td align="left"><pre>void print(std::ostream &Out); // ... print(std::cerr);</pre></td> - <td align="left"><pre>void print(llvm::OStream Out);<sup>1</sup> -// ... -print(llvm::cerr);</pre> + <td align="left"><tt>void print(llvm::OStream Out);<sup><a href="#sn_1">1</a></sup><br> +// ...<br> +print(llvm::cerr);</tt> + </td> + </tr> + </tbody> +</table> -</td> </tbody> </table> -</div> +<p><b>Notes:</b></p> -<div class="doc_text"> -<p><sup>1</sup><tt>llvm::OStream</tt> is a light-weight class so it should never -be passed by reference. This is important because in some configurations, -<tt>DOUT</tt> is an rvalue.</p> +<div class="doc_notes"> +<ol> +<li><a name="sn_1"><tt>llvm::OStream</tt></a> is a light-weight class so it + should never be passed by reference. This is important because in some + configurations, <tt>DOUT</tt> is an rvalue.</li> +</ol> </div> </div> @@ -675,8 +679,8 @@ namespace with an "<tt>std::</tt>" prefix, rather than rely on "<tt>using namespace std;</tt>".</p> <p> In header files, adding a '<tt>using namespace XXX</tt>' directive pollutes -the namespace of any source file that includes the header. This is clearly a -bad thing.</p> +the namespace of any source file that <tt>#include</tt>s the header. This is +clearly a bad thing.</p> <p>In implementation files (e.g. .cpp files), the rule is more of a stylistic rule, but is still important. Basically, using explicit namespace prefixes @@ -710,9 +714,9 @@ others.</p> <p>If a class is defined in a header file and has a v-table (either it has virtual methods or it derives from classes with virtual methods), it must always have at least one out-of-line virtual method in the class. Without -this, the compiler will copy the vtable and RTTI into every .o file that -#includes the header, bloating .o file sizes and increasing link times. -</p> +this, the compiler will copy the vtable and RTTI into every <tt>.o</tt> file +that <tt>#include</tt>s the header, bloating <tt>.o</tt> file sizes and +increasing link times.</p> </div> |