xref: /openbsd-src/gnu/llvm/lldb/docs/doxygen-mainpage.dox (revision 061da546b983eb767bad15e67af1174fb0bcf31c)
1/// @mainpage LLDB
2///
3/// @section main_intro Introduction
4/// Welcome to LLDB.
5///
6/// This documentation describes both the private and public interface of LLDB.
7/// There are no instructions here on how to use LLDB, only the APIs
8/// that make up the software. For usage instructions, please see
9/// the help command.
10///
11/// @section main_caveat Caveat
12/// This documentation is generated directly from the source code with doxygen.
13/// Since LLDB 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 LLDB are very stable.
16