Mercurial Repositories > Eric Assistant / file diff

--- a/AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.Assistant.html	Tue May 25 17:22:05 2021 +0200
+++ b/AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.Assistant.html	Tue May 25 17:48:25 2021 +0200
@@ -169,13 +169,13 @@
 </p>
 <dl>
 
-<dt><i>plugin</i></dt>
+<dt><i>plugin</i> (AssistantEricPlugin)</dt>
 <dd>
 reference to the plugin object
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QObject)</dt>
 <dd>
-parent (QObject)
+parent
 </dd>
 </dl>
 <a NAME="Assistant.__editorClosed" ID="Assistant.__editorClosed"></a>
@@ -187,9 +187,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="Assistant.__editorOpened" ID="Assistant.__editorOpened"></a>
@@ -201,9 +201,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="Assistant.__getApiCalltips" ID="Assistant.__getApiCalltips"></a>
@@ -215,36 +215,41 @@
 </p>
 <dl>
 
-<dt><i>api</i></dt>
+<dt><i>api</i> (APIsManager.DbAPIs)</dt>
 <dd>
-reference to the API object to be used (APIsManager.DbAPIs)
+reference to the API object to be used
 </dd>
-<dt><i>word</i></dt>
+<dt><i>word</i> (str)</dt>
 <dd>
-function to get calltips for (string)
+function to get calltips for
 </dd>
-<dt><i>commas</i></dt>
+<dt><i>commas</i> (int)</dt>
 <dd>
 minimum number of commas contained in the calltip
-            (integer)
 </dd>
-<dt><i>prefix</i></dt>
+<dt><i>prefix</i> (str)</dt>
 <dd>
-prefix of the word to be completed (string)
+prefix of the word to be completed
 </dd>
-<dt><i>module</i></dt>
+<dt><i>module</i> (Module)</dt>
 <dd>
-reference to the scanned module info (Module)
+reference to the scanned module info
 </dd>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
-reference to the editor object (QScintilla.Editor)
+reference to the editor object
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of calltips (list of string)
+list of calltips
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Assistant.__getApiCompletions" ID="Assistant.__getApiCompletions"></a>
@@ -256,35 +261,41 @@
 </p>
 <dl>
 
-<dt><i>api</i></dt>
+<dt><i>api</i> (APIsManager.DbAPIs)</dt>
 <dd>
-reference to the API object to be used (APIsManager.DbAPIs)
+reference to the API object to be used
 </dd>
-<dt><i>word</i></dt>
+<dt><i>word</i> (str)</dt>
 <dd>
-word (or wordpart) to complete (string)
+word (or wordpart) to complete
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (bool)</dt>
 <dd>
-flag indicating to autocomplete a context (boolean)
+flag indicating to autocomplete a context
 </dd>
-<dt><i>prefix</i></dt>
+<dt><i>prefix</i> (str)</dt>
 <dd>
-prefix of the word to be completed (string)
+prefix of the word to be completed
 </dd>
-<dt><i>module</i></dt>
+<dt><i>module</i> (Module)</dt>
 <dd>
-reference to the scanned module info (Module)
+reference to the scanned module info
 </dd>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
-reference to the editor object (QScintilla.Editor.Editor)
+reference to the editor object
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of possible completions (list of strings)
+list of possible completions
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Assistant.__getCompletions" ID="Assistant.__getCompletions"></a>
@@ -296,52 +307,57 @@
 </p>
 <dl>
 
-<dt><i>word</i></dt>
+<dt><i>word</i> (str)</dt>
 <dd>
-word (or wordpart) to complete (string)
+word (or wordpart) to complete
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (bool)</dt>
 <dd>
-flag indicating to autocomplete a context (boolean)
+flag indicating to autocomplete a context
 </dd>
-<dt><i>prefix</i></dt>
+<dt><i>prefix</i> (str)</dt>
 <dd>
-prefix of the word to be completed (string)
+prefix of the word to be completed
 </dd>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-programming language of the source (string)
+programming language of the source
 </dd>
-<dt><i>projectType</i></dt>
+<dt><i>projectType</i> (str)</dt>
 <dd>
-type of the project (string)
+type of the project
 </dd>
-<dt><i>module</i></dt>
+<dt><i>module</i> (Module)</dt>
 <dd>
-reference to the scanned module info (Module)
+reference to the scanned module info
 </dd>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
-reference to the editor object (QScintilla.Editor.Editor)
+reference to the editor object
 </dd>
-<dt><i>importCompletion</i></dt>
+<dt><i>importCompletion</i> (bool)</dt>
 <dd>
-flag indicating an import completion (boolean)
+flag indicating an import completion
 </dd>
-<dt><i>documentOnly</i></dt>
+<dt><i>documentOnly</i> (bool)</dt>
 <dd>
 flag indicating to complete from the document only
-            (boolean)
 </dd>
-<dt><i>sep</i></dt>
+<dt><i>sep</i> (str)</dt>
 <dd>
-separator string (string)
+separator string
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of possible completions (list of strings)
+list of possible completions
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Assistant.__getDocumentCalltips" ID="Assistant.__getDocumentCalltips"></a>
@@ -353,31 +369,37 @@
 </p>
 <dl>
 
-<dt><i>word</i></dt>
+<dt><i>word</i> (str)</dt>
 <dd>
-function to get calltips for (string)
+function to get calltips for
 </dd>
-<dt><i>prefix</i></dt>
+<dt><i>prefix</i> (str)</dt>
 <dd>
-prefix of the word to be completed (string)
+prefix of the word to be completed
 </dd>
-<dt><i>module</i></dt>
+<dt><i>module</i> (Module)</dt>
 <dd>
-reference to the scanned module info (Module)
+reference to the scanned module info
 </dd>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
-reference to the editor object (QScintilla.Editor)
+reference to the editor object
 </dd>
-<dt><i>doHierarchy=</i></dt>
+<dt><i>doHierarchy</i> (bool)</dt>
 <dd>
-flag indicating a hierarchical search (boolean)
+flag indicating a hierarchical search
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of calltips (list of string)
+list of calltips
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Assistant.__getDocumentCompletions" ID="Assistant.__getDocumentCompletions"></a>
@@ -389,39 +411,45 @@
 </p>
 <dl>
 
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
-reference to the editor object (QScintilla.Editor.Editor)
+reference to the editor object
 </dd>
-<dt><i>word</i></dt>
+<dt><i>word</i> (str)</dt>
 <dd>
-string to be completed (string)
+string to be completed
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (bool)</dt>
 <dd>
-flag indicating to autocomplete a context (boolean)
+flag indicating to autocomplete a context
 </dd>
-<dt><i>sep</i></dt>
+<dt><i>sep</i> (str)</dt>
 <dd>
-separator string (string)
+separator string
 </dd>
-<dt><i>prefix</i></dt>
+<dt><i>prefix</i> (str)</dt>
 <dd>
-prefix of the word to be completed (string)
+prefix of the word to be completed
 </dd>
-<dt><i>module</i></dt>
+<dt><i>module</i> (Module)</dt>
 <dd>
-reference to the scanned module info (Module)
+reference to the scanned module info
 </dd>
-<dt><i>doHierarchy=</i></dt>
+<dt><i>doHierarchy</i> (bool)</dt>
 <dd>
-flag indicating a hierarchical search (boolean)
+flag indicating a hierarchical search
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of possible completions (list of strings)
+list of possible completions
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Assistant.__getProjectType" ID="Assistant.__getProjectType"></a>
@@ -467,13 +495,13 @@
 </p>
 <dl>
 
-<dt><i>userListId</i></dt>
+<dt><i>userListId</i> (int)</dt>
 <dd>
-the ID of the user list (should be 1) (integer)
+the ID of the user list (should be 1)
 </dd>
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
 <dd>
-the selected text (string)
+the selected text
 </dd>
 </dl>
 <a NAME="Assistant.__setAutoCompletionHook" ID="Assistant.__setAutoCompletionHook"></a>
@@ -485,9 +513,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="Assistant.__setCalltipsHook" ID="Assistant.__setCalltipsHook"></a>
@@ -499,9 +527,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="Assistant.__shutdown" ID="Assistant.__shutdown"></a>
@@ -520,9 +548,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="Assistant.__unsetCalltipsHook" ID="Assistant.__unsetCalltipsHook"></a>
@@ -534,9 +562,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="Assistant.activate" ID="Assistant.activate"></a>
@@ -555,24 +583,29 @@
 </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>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (int)</dt>
 <dd>
-position in the text for the calltip (integer)
+position in the text for the calltip
 </dd>
-<dt><i>commas</i></dt>
+<dt><i>commas</i> (int)</dt>
 <dd>
 minimum number of commas contained in the calltip
-            (integer)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of possible calltips (list of strings)
+list of possible calltips
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Assistant.deactivate" ID="Assistant.deactivate"></a>
@@ -591,20 +624,25 @@
 </p>
 <dl>
 
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
 reference to the editor object, that called this method
-            (QScintilla.Editor)
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (bool)</dt>
 <dd>
-flag indicating to autocomplete a context (boolean)
+flag indicating to autocomplete a context
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of possible completions (list of strings)
+list of possible completions
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Assistant.setEnabled" ID="Assistant.setEnabled"></a>
@@ -616,13 +654,13 @@
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
 <dd>
-feature to set (string)
+feature to set
 </dd>
-<dt><i>enabled</i></dt>
+<dt><i>enabled</i> (bool)</dt>
 <dd>
-flag indicating the status (boolean)
+flag indicating the status
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>