Mercurial Repositories > Eric Assistant / file diff

--- a/AssistantEric/Documentation/source/Plugin_Assistant_Eric.PluginAssistantEric.html	Tue May 25 17:22:05 2021 +0200
+++ b/AssistantEric/Documentation/source/Plugin_Assistant_Eric.PluginAssistantEric.html	Tue May 25 17:48:25 2021 +0200
@@ -110,11 +110,11 @@
 </tr>
 <tr>
 <td><a href="#AssistantEricPlugin.getPreferences">getPreferences</a></td>
-<td>Public method to retrieve the various refactoring settings.</td>
+<td>Public method to retrieve the various settings.</td>
 </tr>
 <tr>
 <td><a href="#AssistantEricPlugin.setPreferences">setPreferences</a></td>
-<td>Public method to store the various refactoring settings.</td>
+<td>Public method to store the various settings.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
@@ -132,9 +132,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="AssistantEricPlugin.__checkQSql" ID="AssistantEricPlugin.__checkQSql"></a>
@@ -147,7 +147,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating QSql is ok (boolean)
+flag indicating QSql is ok
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="AssistantEricPlugin.__initialize" ID="AssistantEricPlugin.__initialize"></a>
@@ -174,7 +180,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>
+bool
 </dd>
 </dl>
 <a NAME="AssistantEricPlugin.deactivate" ID="AssistantEricPlugin.deactivate"></a>
@@ -189,11 +201,11 @@
 <b>getPreferences</b>(<i>key</i>)
 
 <p>
-        Public method to retrieve the various refactoring settings.
+        Public method to retrieve the various settings.
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
 <dd>
 the key of the value to get
 </dd>
@@ -201,7 +213,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-the requested refactoring setting
+value of the requested setting
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
 </dd>
 </dl>
 <a NAME="AssistantEricPlugin.setPreferences" ID="AssistantEricPlugin.setPreferences"></a>
@@ -209,17 +227,17 @@
 <b>setPreferences</b>(<i>key, value</i>)
 
 <p>
-        Public method to store the various refactoring settings.
+        Public method to store the various settings.
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
 <dd>
-the key of the setting to be set (string)
+the 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>
@@ -234,7 +252,7 @@
 </p>
 <dl>
 
-<dt><i>configDlg</i></dt>
+<dt><i>configDlg</i> (ConfigurationWidget)</dt>
 <dd>
 reference to the configuration dialog
 </dd>
@@ -245,6 +263,12 @@
 reference to the configuration page
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QWidget
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
@@ -257,7 +281,7 @@
 </p>
 <dl>
 
-<dt><i>configDlg</i></dt>
+<dt><i>configDlg</i> (ConfigurationWidget)</dt>
 <dd>
 reference to the configuration dialog
 </dd>
@@ -268,6 +292,12 @@
 reference to the configuration page
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QWidget
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
@@ -284,6 +314,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 />