Add docstrings for some API classes and auto-generates docstrings for the methods of them.

A few of the auto-generated method docstrings don't look right, and may need to be fixed
by either overwriting the auto-gened docstrings or some post-processing steps.

llvm-svn: 134246

13 files changed, 107 insertions, 1 deletions

diff --git a/lldb/include/lldb/API/SBBlock.h b/lldb/include/lldb/API/SBBlock.h
index 7a3b2a61ce8..ed30fb55c20 100644
--- a/lldb/include/lldb/API/SBBlock.h
+++ b/lldb/include/lldb/API/SBBlock.h
@@ -14,8 +14,16 @@
 
 namespace lldb {
 
+#ifdef SWIG
+%feature("docstring",
+         "Represents a lexical block. SBFunction contains SBBlock(s)."
+         ) SBBlock;
+#endif
 class SBBlock
 {
+#ifdef SWIG
+    %feature("autodoc", "1");
+#endif
 public:
 
     SBBlock ();
diff --git a/lldb/include/lldb/API/SBCompileUnit.h b/lldb/include/lldb/API/SBCompileUnit.h
index c6eac794bae..530aad00873 100644
--- a/lldb/include/lldb/API/SBCompileUnit.h
+++ b/lldb/include/lldb/API/SBCompileUnit.h
@@ -15,8 +15,16 @@
 
 namespace lldb {
 
+#ifdef SWIG
+%feature("docstring",
+         "Represents a compilation unit, or compiled source file."
+         ) SBCompileUnit;
+#endif
 class SBCompileUnit
 {
+#ifdef SWIG
+    %feature("autodoc", "1");
+#endif
 public:
 
     SBCompileUnit ();
diff --git a/lldb/include/lldb/API/SBFrame.h b/lldb/include/lldb/API/SBFrame.h
index 2ba56abf1fc..a63fbba4a1e 100644
--- a/lldb/include/lldb/API/SBFrame.h
+++ b/lldb/include/lldb/API/SBFrame.h
@@ -17,8 +17,18 @@ namespace lldb {
 
 class SBValue;
 
+#ifdef SWIG
+%feature("docstring",
+         "Represents one of the stack frames associated with a thread."
+         " SBThread contains SBFrame(s)."
+         ) SBFrame;
+#endif
 class SBFrame
 {
+#ifdef SWIG
+    %feature("autodoc", "1");
+#endif
+
 public:
     SBFrame ();
 
@@ -161,7 +171,9 @@ public:
     bool
     GetDescription (lldb::SBStream &description);
 
+#ifndef SWIG
     SBFrame (const lldb::StackFrameSP &lldb_object_sp);
+#endif
 
 protected:
     friend class SBValue;
diff --git a/lldb/include/lldb/API/SBFunction.h b/lldb/include/lldb/API/SBFunction.h
index 62ce65e687a..be529a5e7d4 100644
--- a/lldb/include/lldb/API/SBFunction.h
+++ b/lldb/include/lldb/API/SBFunction.h
@@ -16,8 +16,16 @@
 
 namespace lldb {
 
+#ifdef SWIG
+%feature("docstring",
+         "Represents a generic function, which can be inlined or not."
+         ) SBFunction;
+#endif
 class SBFunction
 {
+#ifdef SWIG
+    %feature("autodoc", "1");
+#endif
 public:
 
     SBFunction ();
diff --git a/lldb/include/lldb/API/SBLineEntry.h b/lldb/include/lldb/API/SBLineEntry.h
index fb7f8024242..651f9551b13 100644
--- a/lldb/include/lldb/API/SBLineEntry.h
+++ b/lldb/include/lldb/API/SBLineEntry.h
@@ -16,8 +16,17 @@
 
 namespace lldb {
 
+#ifdef SWIG
+%feature("docstring",
+         "Specifies an association with a contiguous range of instructions and"
+         " a source file location. SBCompileUnit contains SBLineEntry(s)."
+         ) SBLineEntry;
+#endif
 class SBLineEntry
 {
+#ifdef SWIG
+    %feature("autodoc", "1");
+#endif
 public:
 
     SBLineEntry ();
diff --git a/lldb/include/lldb/API/SBModule.h b/lldb/include/lldb/API/SBModule.h
index f90d78c8918..bfa84a73f32 100644
--- a/lldb/include/lldb/API/SBModule.h
+++ b/lldb/include/lldb/API/SBModule.h
@@ -16,8 +16,18 @@
 
 namespace lldb {
 
+#ifdef SWIG
+%feature("docstring",
+         "Represents an executable image and its associated object and symbol"
+         " files."
+         ) SBModule;
+#endif
 class SBModule
 {
+#ifdef SWIG
+    %feature("autodoc", "1");
+#endif
+
 public:
 
     SBModule ();
diff --git a/lldb/include/lldb/API/SBProcess.h b/lldb/include/lldb/API/SBProcess.h
index 20eb7720f03..9c6e871b7a7 100644
--- a/lldb/include/lldb/API/SBProcess.h
+++ b/lldb/include/lldb/API/SBProcess.h
@@ -19,8 +19,17 @@ namespace lldb {
 
 class SBEvent;
 
+#ifdef SWIG
+%feature("docstring",
+         "Represents the process associated with the target program."
+         ) SBProcess;
+#endif
 class SBProcess
 {
+#ifdef SWIG
+    %feature("autodoc", "1");
+#endif
+
 public:
     //------------------------------------------------------------------
     /// Broadcaster event bits definitions.
diff --git a/lldb/include/lldb/API/SBSymbol.h b/lldb/include/lldb/API/SBSymbol.h
index f24ebb5f368..21502b0adfa 100644
--- a/lldb/include/lldb/API/SBSymbol.h
+++ b/lldb/include/lldb/API/SBSymbol.h
@@ -17,8 +17,16 @@
 
 namespace lldb {
 
+#ifdef SWIG
+%feature("docstring",
+         "Represents the symbol associated with a stack frame."
+         ) SBSymbol;
+#endif
 class SBSymbol
 {
+#ifdef SWIG
+    %feature("autodoc", "1");
+#endif
 public:
 
     SBSymbol ();
diff --git a/lldb/include/lldb/API/SBSymbolContext.h b/lldb/include/lldb/API/SBSymbolContext.h
index 01eebe1920a..f72bef2643e 100644
--- a/lldb/include/lldb/API/SBSymbolContext.h
+++ b/lldb/include/lldb/API/SBSymbolContext.h
@@ -20,8 +20,16 @@
 
 namespace lldb {
 
+#ifdef SWIG
+%feature("docstring",
+         "A container that stores various debugger related info."
+         ) SBSymbolContext;
+#endif
 class SBSymbolContext
 {
+#ifdef SWIG
+    %feature("autodoc", "1");
+#endif
 public:
     SBSymbolContext ();
 
diff --git a/lldb/include/lldb/API/SBTarget.h b/lldb/include/lldb/API/SBTarget.h
index 283ba5771cc..88d064680fa 100644
--- a/lldb/include/lldb/API/SBTarget.h
+++ b/lldb/include/lldb/API/SBTarget.h
@@ -18,8 +18,16 @@ namespace lldb {
 
 class SBBreakpoint;
 
+#ifdef SWIG
+%feature("docstring",
+         "Represents the target program running under the debugger."
+         ) SBTarget;
+#endif
 class SBTarget
 {
+#ifdef SWIG
+    %feature("autodoc", "1");
+#endif
 public:
     //------------------------------------------------------------------
     // Broadcaster bits.
diff --git a/lldb/include/lldb/API/SBThread.h b/lldb/include/lldb/API/SBThread.h
index 837e20036e4..b4dcf93bc11 100644
--- a/lldb/include/lldb/API/SBThread.h
+++ b/lldb/include/lldb/API/SBThread.h
@@ -18,8 +18,18 @@ namespace lldb {
 
 class SBFrame;
 
+#ifdef SWIG
+%feature("docstring",
+         "Represents a thread of execution."
+         " SBProcess contains SBThread(s)."
+         ) SBThread;
+#endif
 class SBThread
 {
+#ifdef SWIG
+    %feature("autodoc", "1");
+#endif
+
 public:
     SBThread ();
 
diff --git a/lldb/include/lldb/API/SBValue.h b/lldb/include/lldb/API/SBValue.h
index 5187c4726dc..dc9c5dd5642 100644
--- a/lldb/include/lldb/API/SBValue.h
+++ b/lldb/include/lldb/API/SBValue.h
@@ -16,8 +16,16 @@
 
 namespace lldb {
 
+#ifdef SWIG
+%feature("docstring",
+         "Represents the value of a variable, a register, or an expression."
+         ) SBValue;
+#endif
 class SBValue
 {
+#ifdef SWIG
+    %feature("autodoc", "1");
+#endif
 public:
     SBValue ();
 
diff --git a/lldb/scripts/lldb.swig b/lldb/scripts/lldb.swig
index edad13aa4a5..206dd3480d3 100644
--- a/lldb/scripts/lldb.swig
+++ b/lldb/scripts/lldb.swig
@@ -26,7 +26,7 @@ o SBCompileUnit: Represents a compilation unit, or compiled source file.
 o SBFunction: Represents a generic function, which can be inlined or not.
 o SBBlock: Represents a lexical block. SBFunction contains SBBlock(s).
 o SBLineEntry: Specifies an association with a contiguous range of instructions
-      and a source file location. SBCompileUnit contains SBLineEntry(s)"
+      and a source file location. SBCompileUnit contains SBLineEntry(s)."
 %enddef
 
 /*  The name of the module to be created.  */