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