aboutsummaryrefslogtreecommitdiff
path: root/docs/api/intro.h
diff options
context:
space:
mode:
authormike-m <mikem.llvm@gmail.com>2010-05-06 23:46:27 +0000
committermike-m <mikem.llvm@gmail.com>2010-05-06 23:46:27 +0000
commit25a767835262562dc9e8809c057f984d2812cb46 (patch)
tree17054bd129ffb62b28ca8a71567016e50a075bde /docs/api/intro.h
parentcbd66f00cfe5c4412f8efd6e66b0bb6bae956f7c (diff)
2nd part of: Overhauled llvm/clang docs builds.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@103214 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/api/intro.h')
-rw-r--r--docs/api/intro.h23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/api/intro.h b/docs/api/intro.h
new file mode 100644
index 0000000000..6d598310af
--- /dev/null
+++ b/docs/api/intro.h
@@ -0,0 +1,23 @@
+/** @mainpage clang API Documentation
+<div class="intro">
+<div class="logo">
+ <img src="http://llvm.org/img/DragonMedium.png"
+ alg="medium dragon logo" width="400" height="400">
+</div>
+
+@section main_intro Introduction
+Welcome to the clang project.
+
+<br>
+This documentation describes the <b>internal</b> software that makes
+up clang, not the <b>external</b> 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!
+</div>
+*/