summaryrefslogtreecommitdiff
path: root/docs/doxygen-mainpage.dox
diff options
context:
space:
mode:
authorAlexander Kornienko <alexfh@google.com>2016-03-06 03:50:08 +0000
committerAlexander Kornienko <alexfh@google.com>2016-03-06 03:50:08 +0000
commit41664c2aebd333272a74f697d7273f5eee737f4b (patch)
treec80faa3feea1346c71043173ee15d3fd960d19aa /docs/doxygen-mainpage.dox
parentc5c4d22d2664a53393bf87c02ecb9e651b85f63a (diff)
[docs] Updated docs to work with Doxygen 1.8.11
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@262786 91177308-0d34-0410-b5e6-96231b3b80d8
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 00000000000..02a74799bff
--- /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