--- a/AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.APIsManager.html Tue May 25 17:22:05 2021 +0200
+++ b/AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.APIsManager.html Tue May 25 17:48:25 2021 +0200
@@ -117,13 +117,13 @@
</p>
<dl>
-<dt><i>mainWindow</i></dt>
+<dt><i>mainWindow</i> (QMainWindow)</dt>
<dd>
-reference to the main eric6 window (QMainWindow)
+reference to the main eric7 window
</dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QObject)</dt>
<dd>
-reference to the parent object (QObject)
+reference to the parent object
</dd>
</dl>
<a NAME="APIsManager.__apiPreparationStatus" ID="APIsManager.__apiPreparationStatus"></a>
@@ -135,17 +135,17 @@
</p>
<dl>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
<dd>
-language of the API (string)
+language of the API
</dd>
-<dt><i>status</i></dt>
+<dt><i>status</i> (int)</dt>
<dd>
-preparation status (integer, one of WorkerStatus...)
+preparation status (one of WorkerStatus...)
</dd>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
-name of the file being processed (string)
+name of the file being processed
</dd>
</dl>
<a NAME="APIsManager.__showMessage" ID="APIsManager.__showMessage"></a>
@@ -157,9 +157,9 @@
</p>
<dl>
-<dt><i>msg</i></dt>
+<dt><i>msg</i> (str)</dt>
<dd>
-message to be shown (string)
+message to be shown
</dd>
</dl>
<a NAME="APIsManager.deactivate" ID="APIsManager.deactivate"></a>
@@ -387,19 +387,25 @@
</p>
<dl>
-<dt><i>s</i></dt>
+<dt><i>s</i> (str)</dt>
<dd>
-string to check (string)
+string to check
</dd>
-<dt><i>commas</i></dt>
+<dt><i>commas</i> (int)</dt>
<dd>
-number of commas to check for (integer)
+number of commas to check for
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, that there are enough commas (boolean)
+flag indicating, that there are enough commas
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="DbAPIs.__getProjectFormSources" ID="DbAPIs.__getProjectFormSources"></a>
@@ -411,16 +417,21 @@
</p>
<dl>
-<dt><i>normalized=</i></dt>
+<dt><i>normalized</i> (bool)</dt>
<dd>
flag indicating a normalized filename is wanted
- (boolean)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-list of project form sources (list of strings)
+list of project form sources
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="DbAPIs.__initAsLanguage" ID="DbAPIs.__initAsLanguage"></a>
@@ -447,7 +458,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating the prepared status (boolean)
+flag indicating the prepared status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="DbAPIs.__openAPIs" ID="DbAPIs.__openAPIs"></a>
@@ -467,7 +484,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating the database status (boolean)
+flag indicating the database status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="DbAPIs.__processQueue" ID="DbAPIs.__processQueue"></a>
@@ -487,13 +510,13 @@
</p>
<dl>
-<dt><i>status</i></dt>
+<dt><i>status</i> (int)</dt>
<dd>
-preparation status (integer, one of WorkerStatus...)
+preparation status (one of WorkerStatus...)
</dd>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
-name of the file being processed (string)
+name of the file being processed
</dd>
</dl>
<a NAME="DbAPIs.__projectChanged" ID="DbAPIs.__projectChanged"></a>
@@ -519,9 +542,9 @@
</p>
<dl>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
-name of the form file that was compiled (string)
+name of the form file that was compiled
</dd>
</dl>
<a NAME="DbAPIs.__projectOpened" ID="DbAPIs.__projectOpened"></a>
@@ -541,7 +564,13 @@
<dl>
<dt>Return:</dt>
<dd>
-name of the database file (string)
+name of the database file
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="DbAPIs.autoCompletionWordSeparators" ID="DbAPIs.autoCompletionWordSeparators"></a>
@@ -554,7 +583,13 @@
<dl>
<dt>Return:</dt>
<dd>
-word separator characters (list of strings)
+word separator characters
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="DbAPIs.close" ID="DbAPIs.close"></a>
@@ -573,9 +608,9 @@
</p>
<dl>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
-name of the file that was saved (string)
+name of the file that was saved
</dd>
</dl>
<a NAME="DbAPIs.getApiFiles" ID="DbAPIs.getApiFiles"></a>
@@ -588,7 +623,13 @@
<dl>
<dt>Return:</dt>
<dd>
-list of API filenames (list of strings)
+list of API filenames
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="DbAPIs.getCalltips" ID="DbAPIs.getCalltips"></a>
@@ -600,38 +641,42 @@
</p>
<dl>
-<dt><i>acWord</i></dt>
+<dt><i>acWord</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>context</i></dt>
+<dt><i>context</i> (str)</dt>
<dd>
-string giving the context (e.g. classname) (string)
+string giving the context (e.g. classname)
</dd>
-<dt><i>fullContext</i></dt>
+<dt><i>fullContext</i> (str)</dt>
<dd>
-string giving the full context (string)
+string giving the full context
</dd>
-<dt><i>showContext</i></dt>
+<dt><i>showContext</i> (bool)</dt>
<dd>
flag indicating to show the calltip context
- (boolean)
</dd>
-<dt><i>followHierarchy=</i></dt>
+<dt><i>followHierarchy</i> (bool)</dt>
<dd>
flag indicating to follow the hierarchy of
- base classes (boolean)
+ base classes
</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="DbAPIs.getCompletions" ID="DbAPIs.getCompletions"></a>
@@ -643,29 +688,35 @@
</p>
<dl>
-<dt><i>start=</i></dt>
+<dt><i>start</i> (str)</dt>
<dd>
string giving the start of the word to be
- completed (string)
+ completed
</dd>
-<dt><i>context=</i></dt>
+<dt><i>context</i> (str)</dt>
<dd>
string giving the context (e.g. classname)
- to be completed (string)
+ to be completed
</dd>
-<dt><i>followHierarchy=</i></dt>
+<dt><i>followHierarchy</i> (bool)</dt>
<dd>
flag indicating to follow the hierarchy of
- base classes (boolean)
+ base classes
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
list of dictionaries with possible completions
- (key 'completion' contains the completion (string),
- key 'context' contains the context (string) and
- key 'pictureId' contains the ID of the icon to be shown (string))
+ (key 'completion' contains the completion,
+ key 'context' contains the context and
+ key 'pictureId' contains the ID of the icon to be shown)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of dict
</dd>
</dl>
<a NAME="DbAPIs.getLexer" ID="DbAPIs.getLexer"></a>
@@ -678,7 +729,13 @@
<dl>
<dt>Return:</dt>
<dd>
-reference to the lexer object (QScintilla.Lexers.Lexer)
+reference to the lexer object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Lexer
</dd>
</dl>
<a NAME="DbAPIs.prepareAPIs" ID="DbAPIs.prepareAPIs"></a>
@@ -690,9 +747,9 @@
</p>
<dl>
-<dt><i>rawList=</i></dt>
+<dt><i>rawList</i> (list of str)</dt>
<dd>
-list of raw API files (list of strings)
+list of raw API files
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -828,15 +885,21 @@
</p>
<dl>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
<dd>
-language of the APIs object (string)
+language of the APIs object
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-word separator characters (list of strings)
+word separator characters
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="DbAPIsWorker.__classesAttributesApi" ID="DbAPIsWorker.__classesAttributesApi"></a>
@@ -848,15 +911,21 @@
</p>
<dl>
-<dt><i>module</i></dt>
+<dt><i>module</i> (Module)</dt>
<dd>
-module object to get the info from (Module)
+module object to get the info from
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-API information (list of strings)
+API information
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="DbAPIsWorker.__deleteApiFile" ID="DbAPIsWorker.__deleteApiFile"></a>
@@ -868,9 +937,9 @@
</p>
<dl>
-<dt><i>apiFile</i></dt>
+<dt><i>apiFile</i> (str)</dt>
<dd>
-filename of the raw API file (string)
+filename of the raw API file
</dd>
</dl>
<a NAME="DbAPIsWorker.__getApiFiles" ID="DbAPIsWorker.__getApiFiles"></a>
@@ -901,9 +970,9 @@
</p>
<dl>
-<dt><i>apiFile</i></dt>
+<dt><i>apiFile</i> (str)</dt>
<dd>
-filename of the raw API file (string)
+filename of the raw API file
</dd>
</dl>
<a NAME="DbAPIsWorker.__loadApiFileIfNewer" ID="DbAPIsWorker.__loadApiFileIfNewer"></a>
@@ -916,9 +985,9 @@
</p>
<dl>
-<dt><i>apiFile</i></dt>
+<dt><i>apiFile</i> (str)</dt>
<dd>
-filename of the raw API file (string)
+filename of the raw API file
</dd>
</dl>
<a NAME="DbAPIsWorker.__storeApis" ID="DbAPIsWorker.__storeApis"></a>
@@ -930,21 +999,21 @@
</p>
<dl>
-<dt><i>apis</i></dt>
+<dt><i>apis</i> (list of str)</dt>
<dd>
-list of api entries (list of strings)
+list of api entries
</dd>
-<dt><i>bases</i></dt>
+<dt><i>bases</i> (list of str)</dt>
<dd>
-list of base class entries (list of strings)
+list of base class entries
</dd>
-<dt><i>apiFile</i></dt>
+<dt><i>apiFile</i> (str)</dt>
<dd>
-filename of the file read to get the APIs (string)
+filename of the file read to get the APIs
</dd>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
<dd>
-programming language of the file of the APIs (string)
+programming language of the file of the APIs
</dd>
</dl>
<a NAME="DbAPIsWorker.__storeFileInfoOnly" ID="DbAPIsWorker.__storeFileInfoOnly"></a>
@@ -960,9 +1029,9 @@
</p>
<dl>
-<dt><i>apiFile</i></dt>
+<dt><i>apiFile</i> (str)</dt>
<dd>
-file name of the API file (string)
+file name of the API file
</dd>
</dl>
<a NAME="DbAPIsWorker.abort" ID="DbAPIsWorker.abort"></a>
