[rustc.git] / src / llvm / docs / doxygen.intro

/// @mainpage LLVM
///
/// @section main_intro Introduction
/// Welcome to LLVM.
///
/// 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
Commit	Line	Data
223e47cc LB	1	/// @mainpage LLVM
	2	///
	3	/// @section main_intro Introduction
	4	/// Welcome to LLVM.
	5	///
	6	/// This documentation describes the @b internal software that makes
	7	/// up LLVM, not the @b external use of LLVM. There are no instructions
	8	/// here on how to use LLVM, only the APIs that make up the software. For usage
	9	/// instructions, please see the programmer's guide or reference manual.
	10	///
	11	/// @section main_caveat Caveat
	12	/// This documentation is generated directly from the source code with doxygen.
	13	/// Since LLVM is constantly under active development, what you're about to
	14	/// read is out of date! However, it may still be useful since certain portions
	15	/// of LLVM are very stable.
	16	///
	17	/// @section main_changelog Change Log
	18	/// - Original content written 12/30/2003 by Reid Spencer