Commit Graph

85 Commits

Author SHA1 Message Date
NAKAMURA Takumi aa3d6242cf docs: Introduce cascading style <div> and <p> continued on <h[2-5]>.
<h2>Section Example</h2>
<div> <!-- h2+div is applied -->
<p>Section preamble.</p>

<h3>Subsection Example</h3>
<p> <!-- h3+p is applied -->
Subsection body
</p>

<!-- End of section body -->
</div>

FIXME: Care H5 better.
llvm-svn: 130040
2011-04-23 00:30:22 +00:00
NAKAMURA Takumi fc8d930f6e docs: Use <Hn> as Heading elements instead of <DIV class="doc_foo">.
H1 ... doc_title
H2 ... doc_section
H3 ... doc_subsection
H4 ... doc_subsubsection

llvm-svn: 129736
2011-04-18 23:59:50 +00:00
NAKAMURA Takumi ca46f5a3b5 docs: Canonicalize URLs.
llvm-svn: 129181
2011-04-09 02:13:37 +00:00
Nick Lewycky 9d0e8b6e80 Fix typo.
llvm-svn: 126065
2011-02-20 02:03:04 +00:00
Bill Wendling 510504a6e8 Grammar corrections and some formatting changes.
llvm-svn: 122312
2010-12-21 03:31:05 +00:00
Chris Lattner 02093e1f0b fix some validation problems
llvm-svn: 121444
2010-12-10 00:54:03 +00:00
Chris Lattner 77c8cc8fc9 restructure this for readability, correct the example to follow the public ivar name convention
llvm-svn: 121443
2010-12-10 00:52:35 +00:00
Chris Lattner 7365a2838b add a rule for enums, patch by Zhanyong Wan!
llvm-svn: 121430
2010-12-09 23:32:39 +00:00
Zhanyong Wan 4f3b26de28 Add naming rules to the coding standards.
llvm-svn: 120689
2010-12-02 05:10:07 +00:00
Chris Lattner 9db8e15f4d forbid rtti and exceptions
llvm-svn: 120450
2010-11-30 19:20:40 +00:00
Zhanyong Wan 19b96fd4ee Fix formatting nits in the coding standards. Reviewed by clattner.
llvm-svn: 119998
2010-11-23 05:03:07 +00:00
Chris Lattner eebbbeb917 add some justification for "using namespace llvm;"
llvm-svn: 119544
2010-11-17 19:47:20 +00:00
Chris Lattner 8defde09fd various cleanups and other improvements, patch by Zhanyong Wan!
llvm-svn: 119515
2010-11-17 17:14:55 +00:00
Chris Lattner 44c2241cd4 update coding standards. Partial specialization is now ok,
though possibly not a good idea.

llvm-svn: 119398
2010-11-16 22:19:06 +00:00
Chris Lattner 8a7f4dafe5 describe the preferred approach to silencing 'unused variable warnings' due to asserts.
llvm-svn: 118863
2010-11-12 00:19:41 +00:00
Duncan Sands e9da6db67f Convert a bunch of uses of 'bytecode' into 'bitcode'. This
is not everything, but the remaining cases are less trivial.

llvm-svn: 115080
2010-09-29 20:09:55 +00:00
mike-m f375e9a092 Revert r103213. It broke several sections of live website.
llvm-svn: 103219
2010-05-07 00:28:04 +00:00
mike-m e08af303a6 Overhauled llvm/clang docs builds. Closes PR6613.
NOTE: 2nd part changeset for cfe trunk to follow.

*** PRE-PATCH ISSUES ADDRESSED

- clang api docs fail build from objdir
- clang/llvm api docs collide in install PREFIX/
- clang/llvm main docs collide in install
- clang/llvm main docs have full of hard coded destination
  assumptions and make use of absolute root in static html files;
  namely CommandGuide tools hard codes a website destination
  for cross references and some html cross references assume
  website root paths

*** IMPROVEMENTS

- bumped Doxygen from 1.4.x -> 1.6.3
- splits llvm/clang docs into 'main' and 'api' (doxygen) build trees
- provide consistent, reliable doc builds for both main+api docs
- support buid vs. install vs. website intentions
- support objdir builds
- document targets with 'make help'
- correct clean and uninstall operations
- use recursive dir delete only where absolutely necessary
- added call function fn.RMRF which safeguards against botched 'rm -rf';
  if any target (or any variable is evaluated) which attempts
  to remove any dirs which match a hard-coded 'safelist', a verbose
  error will be printed and make will error-stop.

llvm-svn: 103213
2010-05-06 23:45:43 +00:00
Dan Gohman 42f5691d3c Fix typos in comments.
llvm-svn: 97257
2010-02-26 20:18:32 +00:00
Benjamin Kramer 0f4203861f Documentation: Perform automated correction of common typos.
llvm-svn: 83849
2009-10-12 14:46:08 +00:00
Chris Lattner 5db2ff5037 disuade people from using ostream.
llvm-svn: 79866
2009-08-23 21:53:47 +00:00
Chris Lattner 73e9f8c636 make owen happy by being explicit.
llvm-svn: 78688
2009-08-11 17:38:15 +00:00
Chris Lattner 14abb832b2 discourage else after "noreturn" statements.
llvm-svn: 77387
2009-07-28 22:54:04 +00:00
Daniel Dunbar 4bd53c6479 Tweak, raw_ostream is a ostream, not iostream replacement
llvm-svn: 77017
2009-07-24 23:54:34 +00:00
Daniel Dunbar fcd54f73bf CodingStandards: Emphasize use of raw_ostream more.
- Chris, please approve.

llvm-svn: 77010
2009-07-24 23:04:51 +00:00
Chris Lattner d63f12373d fix some wording problems Daniel pointed out, make a example actually real.
llvm-svn: 76751
2009-07-22 16:54:14 +00:00
Chris Lattner 611a1883e5 fix typo noticed by Duncan
llvm-svn: 76747
2009-07-22 16:30:39 +00:00
Chris Lattner 9567fffc36 remove Bill from the author list: his contribution (describing llvm::Ostream
and friends) has been removed awhile ago.

llvm-svn: 76724
2009-07-22 05:43:01 +00:00
Chris Lattner 6720d7edda add some more topics to the coding standards doc:
* Use Early Exits and 'continue' to Simplify Code
* Turn Predicate Loops into Predicate Functions
* Spaces Before Parentheses
* Namespace Indentation
* Anonymous Namespaces

llvm-svn: 76723
2009-07-22 05:40:54 +00:00
Chris Lattner bbe228ba10 be explicit about making comments real sentences.
llvm-svn: 75406
2009-07-12 00:10:24 +00:00
Chris Lattner 67f2a4ac4e got confused again
llvm-svn: 74514
2009-06-30 06:27:54 +00:00
Chris Lattner 6ad089cc54 fix some issues Jeff Yasskin noticed
llvm-svn: 74512
2009-06-30 06:20:03 +00:00
Chris Lattner 56c1094999 add a note about re-evaluating end() every time through a loop.
llvm-svn: 74511
2009-06-30 06:13:23 +00:00
Chris Lattner 57be315d36 tt'ify.
llvm-svn: 67505
2009-03-23 04:53:34 +00:00
Chris Lattner 30bc972596 VC++ 6.0 is not future work :)
Do not recommend llvm::OStream anymore.  Use raw_ostream or MemoryBuffer.

llvm-svn: 67504
2009-03-23 04:52:53 +00:00
Misha Brukman 02805a6423 So *this* is where all the trailing whitespace in file header comments come
from: copy-pasted straight from the coding standards doc!

Oh, the irony.

llvm-svn: 61586
2009-01-02 16:58:42 +00:00
Misha Brukman 586a15c995 * <div align=center> is not valid HTML 4.01 - removed alignment
* <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

llvm-svn: 60889
2008-12-11 19:37:04 +00:00
Misha Brukman 86242e1990 Global replace of yellow W3C "valid HTML/CSS" icons with blue ones.
llvm-svn: 60880
2008-12-11 17:34:48 +00:00
Misha Brukman 6c2522a1cf s/A Few Coding Standards/LLVM Coding Standards/g
llvm-svn: 60859
2008-12-10 23:07:02 +00:00
Nick Lewycky 35847809b7 Fix spelling mistake.
llvm-svn: 60250
2008-11-29 20:13:25 +00:00
Dan Gohman 8ef449828f Fix a few HTML tidiness issues.
llvm-svn: 59966
2008-11-24 17:18:39 +00:00
Matthijs Kooijman ca4ffaabcd Not that using stream headers other than iostream is allowed.
llvm-svn: 54209
2008-07-30 12:14:10 +00:00
Chris Lattner fc12d2e5f3 clarify :)
llvm-svn: 53218
2008-07-08 05:12:37 +00:00
Nick Lewycky fb75d42faa Add a standard for control-flow unreachable assertions in functions that return
values, so as to avoid warnings on some platforms.

llvm-svn: 51831
2008-05-31 23:54:55 +00:00
Chris Lattner ebf5666abf Don't attribute in file headers anymore. See llvmdev for the
discussion of this change.

llvm-svn: 45409
2007-12-29 19:56:08 +00:00
Chris Lattner f9f08bf4b0 Update links.
llvm-svn: 43964
2007-11-09 21:49:08 +00:00
Bill Wendling 56235a28ce Clarify some of the iostreams stuff.
llvm-svn: 43766
2007-11-06 09:36:34 +00:00
Bill Wendling bdd6bd8236 Validation fixes
llvm-svn: 42229
2007-09-22 10:03:25 +00:00
Reid Spencer c7f87f202e Subversionify the documentation.
llvm-svn: 38442
2007-07-09 08:04:31 +00:00
Chris Lattner 8503007331 clarify the 'developed by' line
llvm-svn: 34400
2007-02-19 03:33:06 +00:00