diff -r face142f8fa5 -r 318d7ebbdce2 SelectionEncloser/Documentation/source/Plugin_Tools_Selection_Encloser.PluginSelectionEncloser.html
--- a/SelectionEncloser/Documentation/source/Plugin_Tools_Selection_Encloser.PluginSelectionEncloser.html Tue Jun 01 18:01:14 2021 +0200
+++ b/SelectionEncloser/Documentation/source/Plugin_Tools_Selection_Encloser.PluginSelectionEncloser.html Tue Jun 01 18:45:45 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="SelectionEncloserPlugin.__editorClosed" ID="SelectionEncloserPlugin.__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="SelectionEncloserPlugin.__editorOpened" ID="SelectionEncloserPlugin.__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="SelectionEncloserPlugin.__editorShowMenu" ID="SelectionEncloserPlugin.__editorShowMenu"></a>
@@ -191,26 +191,33 @@
</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>
</dl>
<a NAME="SelectionEncloserPlugin.__encloseSelection" ID="SelectionEncloserPlugin.__encloseSelection"></a>
<h4>SelectionEncloserPlugin.__encloseSelection</h4>
-<b>__encloseSelection</b>(<i></i>)
+<b>__encloseSelection</b>(<i>act</i>)
<p>
Private slot to enclose the selection with the selected string.
</p>
+<dl>
+
+<dt><i>act</i> (QAction)</dt>
+<dd>
+action that triggered
+</dd>
+</dl>
<a NAME="SelectionEncloserPlugin.__initMenu" ID="SelectionEncloserPlugin.__initMenu"></a>
<h4>SelectionEncloserPlugin.__initMenu</h4>
<b>__initMenu</b>(<i></i>)
@@ -234,13 +241,13 @@
</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="SelectionEncloserPlugin.__showMenu" ID="SelectionEncloserPlugin.__showMenu"></a>
@@ -260,7 +267,13 @@
<dl>
<dt>Return:</dt>
<dd>
-tuple of None and activation status (boolean)
+tuple of None and activation status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+(None, bool)
</dd>
</dl>
<a NAME="SelectionEncloserPlugin.deactivate" ID="SelectionEncloserPlugin.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)
+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="SelectionEncloserPlugin.setPreferences" ID="SelectionEncloserPlugin.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>
+SelectionEncloserPage
+</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 />
