mlir/docs/doxygen-mainpage.dox

   1 /// \mainpage MLIR
   2 ///
   3 /// \section main_intro Introduction
   4 /// Welcome to the MLIR project.
   5 ///
   6 /// This documentation describes the **internal** software that makes
   7 /// up MLIR, not the **external** use of MLIR. There are no instructions
   8 /// here on how to use MLIR, only the APIs that make up the software. For
   9 /// usage instructions, please see the [project website](http://mlir.llvm.org)
  10 /// for further detail.
  11 ///
  12 /// \section main_caveat Caveat
  13 /// This documentation is generated directly from the source code with doxygen.
  14 /// Since MLIR is constantly under active development, what you're about to
  15 /// read is out of date!