summaryrefslogtreecommitdiff
path: root/docs/doxygen.intro
diff options
context:
space:
mode:
authorDaniel Dunbar <daniel@zuster.org>2008-07-26 21:32:24 +0000
committerDaniel Dunbar <daniel@zuster.org>2008-07-26 21:32:24 +0000
commit1ede17ad3682e3dbb17fbb0c042f96145e391162 (patch)
tree1df628ec538f534a599c49796bfcb0bfa03dd60d /docs/doxygen.intro
parent28be73f74c9e241a23ea24fe5756623de6bf1084 (diff)
downloadclang-1ede17ad3682e3dbb17fbb0c042f96145e391162.tar.gz
clang-1ede17ad3682e3dbb17fbb0c042f96145e391162.tar.bz2
clang-1ede17ad3682e3dbb17fbb0c042f96145e391162.tar.xz
Add doxygen support
- Stolen from LLVM with minor modifications git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@54103 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!