RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HelpDialog.html

branch
server_client_variant
changeset 204
b4bf79b956bc
parent 55
d501156be247
child 321
d51e810107ec
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HelpDialog.html	Fri Sep 29 10:23:35 2017 +0200
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HelpDialog.html	Fri Sep 29 10:32:30 2017 +0200
@@ -80,15 +80,15 @@
 <p>
         Constructor
 </p><dl>
-<dt><i>title</i></dt>
+<dt><i>title</i> (str)</dt>
 <dd>
-window title (string)
-</dd><dt><i>helpfile</i></dt>
+window title
+</dd><dt><i>helpfile</i> (str)</dt>
 <dd>
-filename of the helpfile (string)
-</dd><dt><i>parent</i></dt>
+filename of the helpfile
+</dd><dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
 </dd>
 </dl><a NAME="HelpDialog.findNextPrev" ID="HelpDialog.findNextPrev"></a>
 <h4>HelpDialog.findNextPrev</h4>
@@ -96,23 +96,28 @@
 <p>
         Public slot to find the next occurrence of a text.
 </p><dl>
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
 <dd>
-text to search for (string)
-</dd><dt><i>case</i></dt>
+text to search for
+</dd><dt><i>case</i> (bool)</dt>
 <dd>
-flag indicating a case sensitive search (boolean)
-</dd><dt><i>word</i></dt>
+flag indicating a case sensitive search
+</dd><dt><i>word</i> (bool)</dt>
 <dd>
-flag indicating a word based search (boolean)
-</dd><dt><i>backwards</i></dt>
+flag indicating a word based search
+</dd><dt><i>backwards</i> (bool)</dt>
 <dd>
-flag indicating a backwards search (boolean)
+flag indicating a backwards search
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating the search found another occurrence (boolean)
+flag indicating the search found another occurrence
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="HelpDialog.helpWidget" ID="HelpDialog.helpWidget"></a>
 <h4>HelpDialog.helpWidget</h4>
@@ -122,7 +127,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-reference to the help widget (QTextEdit)
+reference to the help widget
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+QTextEdit
 </dd>
 </dl><a NAME="HelpDialog.on_buttonBox_clicked" ID="HelpDialog.on_buttonBox_clicked"></a>
 <h4>HelpDialog.on_buttonBox_clicked</h4>
@@ -130,9 +140,9 @@
 <p>
         Private slot called by a button of the button box clicked.
 </p><dl>
-<dt><i>button</i></dt>
+<dt><i>button</i> (QAbstractButton)</dt>
 <dd>
-button that was clicked (QAbstractButton)
+button that was clicked
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial