xref: /llvm-project/lldb/docs/doxygen-mainpage.dox (revision 52cf94090fcba33635bea6810cd09b25c92887cf)
1*52cf9409SJonas Devlieghere/// @mainpage LLDB
2*52cf9409SJonas Devlieghere///
3*52cf9409SJonas Devlieghere/// @section main_intro Introduction
4*52cf9409SJonas Devlieghere/// Welcome to LLDB.
5*52cf9409SJonas Devlieghere///
6*52cf9409SJonas Devlieghere/// This documentation describes both the private and public interface of LLDB.
7*52cf9409SJonas Devlieghere/// There are no instructions here on how to use LLDB, only the APIs
8*52cf9409SJonas Devlieghere/// that make up the software. For usage instructions, please see
9*52cf9409SJonas Devlieghere/// the help command.
10*52cf9409SJonas Devlieghere///
11*52cf9409SJonas Devlieghere/// @section main_caveat Caveat
12*52cf9409SJonas Devlieghere/// This documentation is generated directly from the source code with doxygen.
13*52cf9409SJonas Devlieghere/// Since LLDB is constantly under active development, what you're about to
14*52cf9409SJonas Devlieghere/// read is out of date! However, it may still be useful since certain portions
15*52cf9409SJonas Devlieghere/// of LLDB are very stable.
16