diff options
| author | Enrico Granata <egranata@apple.com> | 2012-05-02 21:00:41 +0000 |
|---|---|---|
| committer | Enrico Granata <egranata@apple.com> | 2012-05-02 21:00:41 +0000 |
| commit | 19e7a185f2217edd9972bad50911fe449a6de7dc (patch) | |
| tree | 4ae6a7ae40d459e5838416abde61dc06e4b848de /lldb/www/python-reference.html | |
| parent | 94c71052e7b99236c66ac933aa60bbc53c9dfbb0 (diff) | |
| download | bcm5719-llvm-19e7a185f2217edd9972bad50911fe449a6de7dc.tar.gz bcm5719-llvm-19e7a185f2217edd9972bad50911fe449a6de7dc.zip | |
Mentioning in the docs that Python commands can have docstrings
llvm-svn: 156018
Diffstat (limited to 'lldb/www/python-reference.html')
| -rwxr-xr-x | lldb/www/python-reference.html | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/lldb/www/python-reference.html b/lldb/www/python-reference.html index 4c2bc5c2e26..6381f0d8c8e 100755 --- a/lldb/www/python-reference.html +++ b/lldb/www/python-reference.html @@ -255,6 +255,13 @@ Enter your Python command(s). Type 'DONE' to end. <code><pre><tt>def command_function(<b>debugger</b>, <b>command</b>, <b>result</b>, <b>dict</b>):
<font color=green># Your code goes here</font>
</tt></pre></code>
+
+ Optionally, you can also provide a Python docstring, and LLDB will use it when providing help for your command, as in:
+ <code><pre><tt>def command_function(<b>debugger</b>, <b>command</b>, <b>result</b>, <b>dict</b>):
+ <font color=green>"""This command takes a lot of options and does many fancy things"""</font>
+ <font color=green># Your code goes here</font>
+ </tt></pre></code>
+
<p><table class="stats" width="620" cellspacing="0">
<tr>
<td class="hed" width="10%">Argument</td>
|
