summaryrefslogtreecommitdiff
path: root/docs/doxygen-mainpage.dox
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen-mainpage.dox')
-rw-r--r--docs/doxygen-mainpage.dox18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/doxygen-mainpage.dox b/docs/doxygen-mainpage.dox
new file mode 100644
index 0000000000000..02a74799bffc9
--- /dev/null
+++ b/docs/doxygen-mainpage.dox
@@ -0,0 +1,18 @@
+/// \mainpage LLVM
+///
+/// \section main_intro Introduction
+/// Welcome to LLVM.
+///
+/// This documentation describes the **internal** software that makes
+/// up LLVM, not the **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