summaryrefslogtreecommitdiffstats
path: root/lldb/scripts/Python/interface/SBBroadcaster.i
diff options
context:
space:
mode:
Diffstat (limited to 'lldb/scripts/Python/interface/SBBroadcaster.i')
-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