summaryrefslogtreecommitdiffstats
path: root/lldb/docs/doxygen.intro
diff options
context:
space:
mode:
authorDaniel Malea <daniel.malea@intel.com>2013-05-28 03:47:34 +0000
committerDaniel Malea <daniel.malea@intel.com>2013-05-28 03:47:34 +0000
commitf92c4a814a65838be223ad7f71719dfebbbcdba1 (patch)
tree9e9119e460dbbc045da895bba32df4438adeeac1 /lldb/docs/doxygen.intro
parentd77e9d45659f73bbe6d1451d1c5a880b596e89f6 (diff)
downloadbcm5719-llvm-f92c4a814a65838be223ad7f71719dfebbbcdba1.tar.gz
bcm5719-llvm-f92c4a814a65838be223ad7f71719dfebbbcdba1.zip
Add CMake targets to build LLDB reference docs
- [ninja|make] lldb-cpp-doc builds the C++ API reference docs - [ninja|make] lldb-python-doc builds the python API reference docs - updated build page on website to include instructions to build docs Tested on Linux/Mac OS X llvm-svn: 182752
Diffstat (limited to 'lldb/docs/doxygen.intro')
-rw-r--r--lldb/docs/doxygen.intro19
1 files changed, 19 insertions, 0 deletions
diff --git a/lldb/docs/doxygen.intro b/lldb/docs/doxygen.intro
new file mode 100644
index 00000000000..2ad0ccb6a29
--- /dev/null
+++ b/lldb/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 by Daniel Malea
+/// - Original content written 12/30/2003 by Reid Spencer
OpenPOWER on IntegriCloud