Overhauled llvm/clang docs builds. Closes PR6613.
NOTE: 2nd part changeset for cfe trunk to follow.
*** PRE-PATCH ISSUES ADDRESSED
- clang api docs fail build from objdir
- clang/llvm api docs collide in install PREFIX/
- clang/llvm main docs collide in install
- clang/llvm main docs have full of hard coded destination
assumptions and make use of absolute root in static html files;
namely CommandGuide tools hard codes a website destination
for cross references and some html cross references assume
website root paths
*** IMPROVEMENTS
- bumped Doxygen from 1.4.x -> 1.6.3
- splits llvm/clang docs into 'main' and 'api' (doxygen) build trees
- provide consistent, reliable doc builds for both main+api docs
- support buid vs. install vs. website intentions
- support objdir builds
- document targets with 'make help'
- correct clean and uninstall operations
- use recursive dir delete only where absolutely necessary
- added call function fn.RMRF which safeguards against botched 'rm -rf';
if any target (or any variable is evaluated) which attempts
to remove any dirs which match a hard-coded 'safelist', a verbose
error will be printed and make will error-stop.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@103213 91177308-0d34-0410-b5e6-96231b3b80d8
diff --git a/docs/api/intro.h b/docs/api/intro.h
new file mode 100644
index 0000000..d3e78e4
--- /dev/null
+++ b/docs/api/intro.h
@@ -0,0 +1,26 @@
+/** @mainpage LLVM 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 Low Level Virtual Machine (LLVM).
+
+<br>
+This documentation describes the @b internal software that makes
+up LLVM, not the @b 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
+</div>
+*/