Mercurial Repositories > Eric Assistant / file diff

--- a/AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.APIsManager.html	Sat Nov 26 14:43:28 2016 +0100
+++ b/AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.APIsManager.html	Sat Dec 03 18:08:44 2016 +0100
@@ -82,6 +82,9 @@
 <td><a href="#APIsManager.__showMessage">__showMessage</a></td>
 <td>Private message to show a message in the main windows status bar.</td>
 </tr><tr>
+<td><a href="#APIsManager.__supportedApiLanguages">__supportedApiLanguages</a></td>
+<td>Private method to build a list of supported API languages.</td>
+</tr><tr>
 <td><a href="#APIsManager.deactivate">deactivate</a></td>
 <td>Public method to perform actions upon deactivation.</td>
 </tr><tr>
@@ -166,6 +169,24 @@
 <dd>
 message to be shown (string)
 </dd>
+</dl><a NAME="APIsManager.__supportedApiLanguages" ID="APIsManager.__supportedApiLanguages"></a>
+<h4>APIsManager.__supportedApiLanguages</h4>
+<b>__supportedApiLanguages</b>(<i></i>)
+<p>
+        Private method to build a list of supported API languages.
+</p><p>
+        Note: This is a compatibility method to make this code work with
+        older eric versions.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of supported API languages
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
 </dl><a NAME="APIsManager.deactivate" ID="APIsManager.deactivate"></a>
 <h4>APIsManager.deactivate</h4>
 <b>deactivate</b>(<i></i>)
@@ -173,7 +194,7 @@
         Public method to perform actions upon deactivation.
 </p><a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a>
 <h4>APIsManager.getAPIs</h4>
-<b>getAPIs</b>(<i>language</i>)
+<b>getAPIs</b>(<i>language, projectType=""</i>)
 <p>
         Public method to get an apis object for autocompletion/calltips.
 </p><p>
@@ -181,14 +202,22 @@
         This saves memory for languages, that might not be needed at the
         moment.
 </p><dl>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-the language of the requested api object (string)
+language of the requested APIs object
+</dd><dt><i>projectType</i> (str)</dt>
+<dd>
+type of the project
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-the apis object (APIs)
+reference to the APIs object
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+APIs
 </dd>
 </dl><a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a>
 <h4>APIsManager.reloadAPIs</h4>
@@ -302,16 +331,19 @@
 </table>
 <a NAME="DbAPIs.__init__" ID="DbAPIs.__init__"></a>
 <h4>DbAPIs (Constructor)</h4>
-<b>DbAPIs</b>(<i>language, parent=None</i>)
+<b>DbAPIs</b>(<i>language, projectType="", parent=None</i>)
 <p>
         Constructor
 </p><dl>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
+<dd>
+language of the APIs object
+</dd><dt><i>projectType</i> (str)</dt>
 <dd>
-language of the APIs object (string)
-</dd><dt><i>parent</i></dt>
+type of the project
+</dd><dt><i>parent</i> (QObject)</dt>
 <dd>
-reference to the parent object (QObject)
+reference to the parent object
 </dd>
 </dl><a NAME="DbAPIs.__createApiDB" ID="DbAPIs.__createApiDB"></a>
 <h4>DbAPIs.__createApiDB</h4>
@@ -622,27 +654,29 @@
 </table>
 <a NAME="DbAPIsWorker.__init__" ID="DbAPIsWorker.__init__"></a>
 <h4>DbAPIsWorker (Constructor)</h4>
-<b>DbAPIsWorker</b>(<i>proxy, language, apiFiles, projectPath="", refresh=False</i>)
+<b>DbAPIsWorker</b>(<i>proxy, language, apiFiles, projectPath="", refresh=False, projectType=""</i>)
 <p>
         Constructor
 </p><dl>
-<dt><i>proxy</i></dt>
+<dt><i>proxy</i> (DbAPIs)</dt>
 <dd>
-reference to the object that is proxied (DbAPIs)
-</dd><dt><i>language</i></dt>
+reference to the object that is proxied
+</dd><dt><i>language</i> (str)</dt>
 <dd>
-language of the APIs object (string)
-</dd><dt><i>apiFiles</i></dt>
+language of the APIs object
+</dd><dt><i>apiFiles</i> (list of str)</dt>
 <dd>
-list of API files to process (list of strings)
-</dd><dt><i>projectPath</i></dt>
+list of API files to process
+</dd><dt><i>projectPath</i> (str)</dt>
 <dd>
 path of the project. Only needed, if the APIs
-            are extracted out of the sources of a project. (string)
-</dd><dt><i>refresh</i></dt>
+            are extracted out of the sources of a project.
+</dd><dt><i>refresh</i> (bool)</dt>
 <dd>
 flag indicating a refresh of the APIs of one file
-            (boolean)
+</dd><dt><i>projectType</i> (str)</dt>
+<dd>
+type of the project
 </dd>
 </dl><a NAME="DbAPIsWorker.__autoCompletionWordSeparators" ID="DbAPIsWorker.__autoCompletionWordSeparators"></a>
 <h4>DbAPIsWorker.__autoCompletionWordSeparators</h4>