aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen.intro
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen.intro')
-rw-r--r--docs/doxygen.intro19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/doxygen.intro b/docs/doxygen.intro
new file mode 100644
index 000000000000..1e5cd2787ff1
--- /dev/null
+++ b/docs/doxygen.intro
@@ -0,0 +1,19 @@
+/// @mainpage LLDB
+///
+/// @section main_intro Introduction
+/// Welcome to LLDB.
+///
+/// This documentation describes the @b interface that can drive LLDB.
+/// There are no instructions here on how to use LLDB, only the APIs
+/// that make up the software. For usage instructions, please see
+/// the help command.
+///
+/// @section main_caveat Caveat
+/// This documentation is generated directly from the source code with doxygen.
+/// Since LLDB is constantly under active development, what you're about to
+/// read is out of date! However, it may still be useful since certain portions
+/// of LLDB are very stable.
+///
+/// @section main_changelog Change Log
+/// - Adapted for LLDB 05/25/2013 by Daniel Malea
+/// - Original content written 12/30/2003 by Reid Spencer