Mercurial Repositories > Print Remover Tool / file diff

--- a/PrintRemover/Documentation/source/Plugin_Tools_Print_Remover.PluginPrintRemover.html	Mon May 31 17:36:21 2021 +0200
+++ b/PrintRemover/Documentation/source/Plugin_Tools_Print_Remover.PluginPrintRemover.html	Mon May 31 17:43:54 2021 +0200
@@ -148,9 +148,9 @@
 </p>
 <dl>
 
-<dt><i>ui</i></dt>
+<dt><i>ui</i> (UserInterface)</dt>
 <dd>
-reference to the user interface object (UI.UserInterface)
+reference to the user interface object
 </dd>
 </dl>
 <a NAME="PrintRemoverPlugin.__editorClosed" ID="PrintRemoverPlugin.__editorClosed"></a>
@@ -162,9 +162,9 @@
 </p>
 <dl>
 
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
-reference to the editor (QScintilla.Editor)
+reference to the editor
 </dd>
 </dl>
 <a NAME="PrintRemoverPlugin.__editorOpened" ID="PrintRemoverPlugin.__editorOpened"></a>
@@ -176,9 +176,9 @@
 </p>
 <dl>
 
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
-reference to the new editor (QScintilla.Editor)
+reference to the new editor
 </dd>
 </dl>
 <a NAME="PrintRemoverPlugin.__editorShowMenu" ID="PrintRemoverPlugin.__editorShowMenu"></a>
@@ -191,15 +191,15 @@
 </p>
 <dl>
 
-<dt><i>menuName</i></dt>
+<dt><i>menuName</i> (str)</dt>
 <dd>
-name of the menu to be shown (string)
+name of the menu to be shown
 </dd>
-<dt><i>menu</i></dt>
+<dt><i>menu</i> (QMenu)</dt>
 <dd>
-reference to the menu (QMenu)
+reference to the menu
 </dd>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
 reference to the editor
 </dd>
@@ -227,22 +227,29 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the menu (string)
+name of the menu
 </dd>
-<dt><i>menu</i></dt>
+<dt><i>menu</i> (QMenu)</dt>
 <dd>
-reference to the menu to be populated (QMenu)
+reference to the menu to be populated
 </dd>
 </dl>
 <a NAME="PrintRemoverPlugin.__removeLine" ID="PrintRemoverPlugin.__removeLine"></a>
 <h4>PrintRemoverPlugin.__removeLine</h4>
-<b>__removeLine</b>(<i></i>)
+<b>__removeLine</b>(<i>act</i>)
 
 <p>
         Private slot to remove lines starting with the selected pattern.
 </p>
+<dl>
+
+<dt><i>act</i> (QAction)</dt>
+<dd>
+reference to the action that was triggered
+</dd>
+</dl>
 <a NAME="PrintRemoverPlugin.__showMenu" ID="PrintRemoverPlugin.__showMenu"></a>
 <h4>PrintRemoverPlugin.__showMenu</h4>
 <b>__showMenu</b>(<i></i>)
@@ -260,7 +267,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple of None and activation status (boolean)
+tuple of None and activation statu
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (None, bool)
 </dd>
 </dl>
 <a NAME="PrintRemoverPlugin.deactivate" ID="PrintRemoverPlugin.deactivate"></a>
@@ -279,15 +292,21 @@
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
 <dd>
-the key of the value to get (string)
+the key of the value to get
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-the requested setting
+value of the requested setting
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
 </dd>
 </dl>
 <a NAME="PrintRemoverPlugin.setPreferences" ID="PrintRemoverPlugin.setPreferences"></a>
@@ -299,13 +318,13 @@
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
 <dd>
-the key of the setting to be set (string)
+key of the setting to be set
 </dd>
-<dt><i>value</i></dt>
+<dt><i>value</i> (Any)</dt>
 <dd>
-the value to be set
+value to be set
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -320,7 +339,7 @@
 </p>
 <dl>
 
-<dt><i>configDlg</i></dt>
+<dt><i>configDlg</i> (ConfigurationWidget)</dt>
 <dd>
 reference to the configuration dialog
 </dd>
@@ -331,6 +350,12 @@
 reference to the configuration page
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+PrintRemoverPage
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
@@ -347,6 +372,12 @@
 dictionary containing the relevant data
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />