aboutsummaryrefslogtreecommitdiff
path: root/llvm/docs/doxygen.intro
diff options
context:
space:
mode:
authorChris Lattner <sabre@nondot.org>2003-12-31 06:47:28 +0000
committerChris Lattner <sabre@nondot.org>2003-12-31 06:47:28 +0000
commite7f42f72d32f7ff793bf0b0e3942a85ed9bccf38 (patch)
tree8b5dfe6e9a245574848510ace26cee6b94c01b1d /llvm/docs/doxygen.intro
parente87006eb7e297194cf45c18be336abd85068fb48 (diff)
downloadllvm-e7f42f72d32f7ff793bf0b0e3942a85ed9bccf38.zip
llvm-e7f42f72d32f7ff793bf0b0e3942a85ed9bccf38.tar.gz
llvm-e7f42f72d32f7ff793bf0b0e3942a85ed9bccf38.tar.bz2
Add a bunch of fine tunings that Reid contributed. Thanks Reid!
llvm-svn: 10666
Diffstat (limited to 'llvm/docs/doxygen.intro')
-rw-r--r--llvm/docs/doxygen.intro25
1 files changed, 25 insertions, 0 deletions
diff --git a/llvm/docs/doxygen.intro b/llvm/docs/doxygen.intro
new file mode 100644
index 0000000..f65bfaa
--- /dev/null
+++ b/llvm/docs/doxygen.intro
@@ -0,0 +1,25 @@
+////////////////////////////////////////////////////////////////////////////////
+/// @file doxygen.intro
+/// @author Reid Spencer <rspencer@x10sys.com>
+/// @date 2003/12/30
+/// @brief LLVM API documentation introduction.
+////////////////////////////////////////////////////////////////////////////////
+///
+/// @mainpage LLVM:Low Level Virtual Machine
+///
+/// @section main_intro Introduction
+/// Welcome to the Low Level Virtual Machine (LLVM)
+///
+/// This documentation describes the @b internal software that makes
+/// up LLVM, not the @b external use of LLVM. There are no instructions
+/// here on how to use LLVM, only the APIs that make up the software. For usage
+/// instructions, please see the programmer's guide or reference manual.
+///
+/// @section main_caveat Caveat
+/// This documentation is generated directly from the source code with doxygen.
+/// Since LLVM is constantly under active development, what you're about to
+/// read is out of date! However, it may still be useful since certain portions of
+/// LLVM are very stable.
+///
+/// @section main_changelog Change Log
+/// - Original content written 12/30/2003 by Reid Spencer