diff options
Diffstat (limited to 'docs/api/intro.h')
| -rw-r--r-- | docs/api/intro.h | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/api/intro.h b/docs/api/intro.h new file mode 100644 index 0000000000..d3e78e435d --- /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> +*/ |