blob: 547730cba79c9e1b8f1b45b6b3c84cbc3521b54a [file] [log] [blame]
Reid Spencere53b5c12004-11-29 03:47:37 +00001/// @mainpage Low Level Virtual Machine
Chris Lattnerb0fa6592003-12-31 06:47:28 +00002///
3/// @section main_intro Introduction
Reid Spencere53b5c12004-11-29 03:47:37 +00004/// Welcome to the Low Level Virtual Machine (LLVM).
Chris Lattnerb0fa6592003-12-31 06:47:28 +00005///
6/// This documentation describes the @b internal software that makes
7/// up LLVM, not the @b external use of LLVM. There are no instructions
8/// here on how to use LLVM, only the APIs that make up the software. For usage
9/// instructions, please see the programmer's guide or reference manual.
10///
11/// @section main_caveat Caveat
12/// This documentation is generated directly from the source code with doxygen.
13/// Since LLVM is constantly under active development, what you're about to
Misha Brukman90147432004-06-03 15:23:59 +000014/// read is out of date! However, it may still be useful since certain portions
15/// of LLVM are very stable.
Chris Lattnerb0fa6592003-12-31 06:47:28 +000016///
17/// @section main_changelog Change Log
18/// - Original content written 12/30/2003 by Reid Spencer