summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJohnny Chen <johnny.chen@apple.com>2011-07-20 22:29:58 +0000
committerJohnny Chen <johnny.chen@apple.com>2011-07-20 22:29:58 +0000
commit2e16d5dc8f9f4d160b611193889774718bf0d8a9 (patch)
tree3b91483c83a3e9ba4d8eee9455f61f5ffe9ada20
parent8fb9fd6769b530eb05ab9e1db534948ed752a6e3 (diff)
downloadbcm5719-llvm-2e16d5dc8f9f4d160b611193889774718bf0d8a9.tar.gz
bcm5719-llvm-2e16d5dc8f9f4d160b611193889774718bf0d8a9.zip
Add docstring for SBBroadcaster class.
llvm-svn: 135630
-rw-r--r--lldb/scripts/Python/interface/SBBroadcaster.i11
1 files changed, 11 insertions, 0 deletions
diff --git a/lldb/scripts/Python/interface/SBBroadcaster.i b/lldb/scripts/Python/interface/SBBroadcaster.i
index 2e40d914b9f..ece38f602c4 100644
--- a/lldb/scripts/Python/interface/SBBroadcaster.i
+++ b/lldb/scripts/Python/interface/SBBroadcaster.i
@@ -9,6 +9,17 @@
namespace lldb {
+%feature("docstring",
+"Represents an entity which can broadcast events. A default broadcaster is
+associated with an SBCommandInterpreter, SBProcess, and SBTarget. For
+example, use
+
+ broadcaster = process.GetBroadcaster()
+
+to retrieve the process's broadcaster.
+
+See also SBEvent for example usage of interacting with a broadcaster."
+) SBBroadcaster;
class SBBroadcaster
{
public:
OpenPOWER on IntegriCloud