bolt/docs/doxygen-mainpage.dox

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