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

* <div align=center> is not valid HTML 4.01 - removed alignment

Browse Source 
* <sup> cannot appear inside a <pre> - replaced <pre> with <tt> and <br>
* Added standard "Notes" section
* Sprinkled fixed-width <tt> tags in a few places for consistency


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@60889 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Misha Brukman 2008-12-11 19:37:04 +00:00
parent f00ddb04df
commit 2d33c5443a
1 changed files with 19 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/CodingStandards.html
View File

@ -526,7 +526,6 @@ library. There are two problems with this:</p>
example) is allowed normally, it is just <tt>&lt;iostream&gt;</tt> that is example) is allowed normally, it is just <tt>&lt;iostream&gt;</tt> that is
causing problems.</p> causing problems.</p>
<div align="center">
<table> <table>
<tbody> <tbody>
<tr> <tr>
@ -571,17 +570,22 @@ DEBUG(dump(DOUT));</pre></td>
<td align="left"><pre>void print(std::ostream &amp;Out); <td align="left"><pre>void print(std::ostream &amp;Out);
// ... // ...
print(std::cerr);</pre></td> print(std::cerr);</pre></td>
<td align="left"><pre>void print(llvm::OStream Out);<sup>1</sup> <td align="left"><tt>void print(llvm::OStream Out);<sup><a href="#sn_1">1</a></sup><br>
// ... // ...<br>
print(llvm::cerr);</pre> print(llvm::cerr);</tt>
</td>
</tr>
</tbody>
</table>
</td> </tbody> </table> <p><b>Notes:</b></p>
</div>
<div class="doc_text"> <div class="doc_notes">
<p><sup>1</sup><tt>llvm::OStream</tt> is a light-weight class so it should never <ol>
be passed by reference. This is important because in some configurations, <li><a name="sn_1"><tt>llvm::OStream</tt></a> is a light-weight class so it
<tt>DOUT</tt> is an rvalue.</p> should never be passed by reference. This is important because in some
configurations, <tt>DOUT</tt> is an rvalue.</li>
</ol>
</div> </div>
</div> </div>
@ -675,8 +679,8 @@ namespace with an "<tt>std::</tt>" prefix, rather than rely on
"<tt>using namespace std;</tt>".</p> "<tt>using namespace std;</tt>".</p>
<p> In header files, adding a '<tt>using namespace XXX</tt>' directive pollutes <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 the namespace of any source file that <tt>#include</tt>s the header. This is
bad thing.</p> clearly a bad thing.</p>
<p>In implementation files (e.g. .cpp files), the rule is more of a stylistic <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 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 <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 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 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 this, the compiler will copy the vtable and RTTI into every <tt>.o</tt> file
#includes the header, bloating .o file sizes and increasing link times. that <tt>#include</tt>s the header, bloating <tt>.o</tt> file sizes and
</p> increasing link times.</p>
</div> </div>