xref: /aosp_15_r20/external/llvm/docs/doxygen-mainpage.dox (revision 9880d6810fe72a1726cb53787c6711e909410d58)
1*9880d681SAndroid Build Coastguard Worker/// \mainpage LLVM
2*9880d681SAndroid Build Coastguard Worker///
3*9880d681SAndroid Build Coastguard Worker/// \section main_intro Introduction
4*9880d681SAndroid Build Coastguard Worker/// Welcome to LLVM.
5*9880d681SAndroid Build Coastguard Worker///
6*9880d681SAndroid Build Coastguard Worker/// This documentation describes the **internal** software that makes
7*9880d681SAndroid Build Coastguard Worker/// up LLVM, not the **external** use of  LLVM. There are no instructions
8*9880d681SAndroid Build Coastguard Worker/// here on how to use LLVM, only the APIs that make up the software. For usage
9*9880d681SAndroid Build Coastguard Worker/// instructions, please see the programmer's guide or reference manual.
10*9880d681SAndroid Build Coastguard Worker///
11*9880d681SAndroid Build Coastguard Worker/// \section main_caveat Caveat
12*9880d681SAndroid Build Coastguard Worker/// This documentation is generated directly from the source code with doxygen.
13*9880d681SAndroid Build Coastguard Worker/// Since LLVM is constantly under active development, what you're about to
14*9880d681SAndroid Build Coastguard Worker/// read is out of date! However, it may still be useful since certain portions
15*9880d681SAndroid Build Coastguard Worker/// of LLVM are very stable.
16*9880d681SAndroid Build Coastguard Worker///
17*9880d681SAndroid Build Coastguard Worker/// \section main_changelog Change Log
18*9880d681SAndroid Build Coastguard Worker/// - Original content written 12/30/2003 by Reid Spencer
19