summaryrefslogtreecommitdiffstats
path: root/docs/doxygen.intro
diff options
context:
space:
mode:
authormike-m <mikem.llvm@gmail.com>2010-05-07 00:42:33 +0000
committermike-m <mikem.llvm@gmail.com>2010-05-07 00:42:33 +0000
commit3e5d00c2c727e54d96ce984edfc5cca4710eae10 (patch)
tree1486fcced3985d138da8a6b426b0d698f53f3f0a /docs/doxygen.intro
parent6fb94391dc7cb11fd4bbdb969bbab11b6b48c223 (diff)
Reverted r103214.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@103222 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/doxygen.intro')
-rw-r--r--docs/doxygen.intro15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/doxygen.intro b/docs/doxygen.intro
new file mode 100644
index 0000000000..accab72bd0
--- /dev/null
+++ b/docs/doxygen.intro
@@ -0,0 +1,15 @@
+/// @mainpage clang
+///
+/// @section main_intro Introduction
+/// Welcome to the clang project.
+///
+/// This documentation describes the @b internal software that makes
+/// up clang, not the @b external use of clang. There are no instructions
+/// here on how to use clang, 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 clang is constantly under active development, what you're about to
+/// read is out of date!