docs/doxygen.intro

   1 ////////////////////////////////////////////////////////////////////////////////
   2 /// @file doxygen.intro
   3 /// @author Reid Spencer <rspencer@x10sys.com>
   4 /// @date 2003/12/30
   5 /// @brief LLVM API documentation introduction.
   6 ////////////////////////////////////////////////////////////////////////////////
   7 ///
   8 /// @mainpage LLVM:Low Level Virtual Machine
   9 ///
  10 /// @section main_intro Introduction
  11 /// Welcome to the Low Level Virtual Machine (LLVM)
  12 ///
  13 /// This documentation describes the @b internal software that makes
  14 /// up LLVM, not the @b external use of  LLVM. There are no instructions
  15 /// here on how to use LLVM, only the APIs that make up the software. For usage
  16 /// instructions, please see the programmer's guide or reference manual.
  17 ///
  18 /// @section main_caveat Caveat
  19 /// This documentation is generated directly from the source code with doxygen.
  20 /// Since LLVM is constantly under active development, what you're about to
  21 /// read is out of date! However, it may still be useful since certain portions of
  22 /// LLVM are very stable.
  23 ///
  24 /// @section main_changelog Change Log
  25 /// - Original content written 12/30/2003 by Reid Spencer