summaryrefslogtreecommitdiff
path: root/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
commitb0fa6599811adac127f95289567dc20d97187442 (patch)
tree4e72c62f2a8b07079c642ef6fa2826f6f7de7688 /docs/doxygen.intro
parent7a312bc102efbbf725e5a85d412df8da7e22744d (diff)
Add a bunch of fine tunings that Reid contributed. Thanks Reid!
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@10666 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/doxygen.intro')
-rw-r--r--docs/doxygen.intro25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/doxygen.intro b/docs/doxygen.intro
new file mode 100644
index 00000000000..f65bfaa2ece
--- /dev/null
+++ b/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