summaryrefslogtreecommitdiff
path: root/docs/api/intro.h
blob: d3e78e435d5c8f36034c281fd23e61190e1a939b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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>
*/