Documentation/Source/eric6.QScintilla.APIsManager.html

branch
APIs
changeset 5352
ddcf6fd8c316
parent 4134
c04c703d1ca4
--- a/Documentation/Source/eric6.QScintilla.APIsManager.html	Thu Dec 01 19:18:56 2016 +0100
+++ b/Documentation/Source/eric6.QScintilla.APIsManager.html	Thu Dec 01 19:22:06 2016 +0100
@@ -87,12 +87,12 @@
 <td><a href="#APIs.__apiPreparationStarted">__apiPreparationStarted</a></td>
 <td>Private method called, when the API preparation process started.</td>
 </tr><tr>
-<td><a href="#APIs.__defaultPreparedName">__defaultPreparedName</a></td>
-<td>Private method returning the default name of a prepared API file.</td>
-</tr><tr>
 <td><a href="#APIs.__loadAPIs">__loadAPIs</a></td>
 <td>Private method to load the APIs.</td>
 </tr><tr>
+<td><a href="#APIs.__preparedName">__preparedName</a></td>
+<td>Private method returning the default name of a prepared API file.</td>
+</tr><tr>
 <td><a href="#APIs.cancelPreparation">cancelPreparation</a></td>
 <td>Public slot to cancel the APIs preparation.</td>
 </tr><tr>
@@ -118,20 +118,23 @@
 </table>
 <a NAME="APIs.__init__" ID="APIs.__init__"></a>
 <h4>APIs (Constructor)</h4>
-<b>APIs</b>(<i>language, forPreparation=False, parent=None</i>)
+<b>APIs</b>(<i>language, projectType="", forPreparation=False, parent=None</i>)
 <p>
         Constructor
 </p><dl>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-language of the APIs object (string)
-</dd><dt><i>forPreparation</i></dt>
+language of the APIs object
+</dd><dt><i>projectType</i> (str)</dt>
+<dd>
+type of the project
+</dd><dt><i>forPreparation</i> (bool)</dt>
 <dd>
 flag indicating this object is just needed
-            for a preparation process (boolean)
-</dd><dt><i>parent</i></dt>
+            for a preparation process
+</dd><dt><i>parent</i> (QObject)</dt>
 <dd>
-reference to the parent object (QObject)
+reference to the parent object
 </dd>
 </dl><a NAME="APIs.__apiPreparationCancelled" ID="APIs.__apiPreparationCancelled"></a>
 <h4>APIs.__apiPreparationCancelled</h4>
@@ -149,9 +152,14 @@
 <b>__apiPreparationStarted</b>(<i></i>)
 <p>
         Private method called, when the API preparation process started.
-</p><a NAME="APIs.__defaultPreparedName" ID="APIs.__defaultPreparedName"></a>
-<h4>APIs.__defaultPreparedName</h4>
-<b>__defaultPreparedName</b>(<i></i>)
+</p><a NAME="APIs.__loadAPIs" ID="APIs.__loadAPIs"></a>
+<h4>APIs.__loadAPIs</h4>
+<b>__loadAPIs</b>(<i></i>)
+<p>
+        Private method to load the APIs.
+</p><a NAME="APIs.__preparedName" ID="APIs.__preparedName"></a>
+<h4>APIs.__preparedName</h4>
+<b>__preparedName</b>(<i></i>)
 <p>
         Private method returning the default name of a prepared API file.
 </p><dl>
@@ -159,12 +167,7 @@
 <dd>
 complete filename for the Prepared APIs file (string)
 </dd>
-</dl><a NAME="APIs.__loadAPIs" ID="APIs.__loadAPIs"></a>
-<h4>APIs.__loadAPIs</h4>
-<b>__loadAPIs</b>(<i></i>)
-<p>
-        Private method to load the APIs.
-</p><a NAME="APIs.cancelPreparation" ID="APIs.cancelPreparation"></a>
+</dl><a NAME="APIs.cancelPreparation" ID="APIs.cancelPreparation"></a>
 <h4>APIs.cancelPreparation</h4>
 <b>cancelPreparation</b>(<i></i>)
 <p>
@@ -243,7 +246,7 @@
 <td>Constructor</td>
 </tr><tr>
 <td><a href="#APIsManager.getAPIs">getAPIs</a></td>
-<td>Public method to get an apis object for autocompletion/calltips.</td>
+<td>Public method to get an APIs object for autocompletion/calltips.</td>
 </tr><tr>
 <td><a href="#APIsManager.reloadAPIs">reloadAPIs</a></td>
 <td>Public slot to reload the api information.</td>
@@ -265,26 +268,34 @@
 </dd>
 </dl><a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a>
 <h4>APIsManager.getAPIs</h4>
-<b>getAPIs</b>(<i>language, forPreparation=False</i>)
+<b>getAPIs</b>(<i>language, projectType="", forPreparation=False</i>)
 <p>
-        Public method to get an apis object for autocompletion/calltips.
+        Public method to get an APIs object for autocompletion/calltips.
 </p><p>
         This method creates and loads an APIs object dynamically upon request.
         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>
+language of the requested APIs object
+</dd><dt><i>projectType</i> (str)</dt>
 <dd>
-the language of the requested api object (string)
-</dd><dt><i>forPreparation</i></dt>
+type of the project
+</dd><dt><i>forPreparation</i> (bool)</dt>
 <dd>
-flag indicating the requested api object is just
-            needed for a preparation process (boolean)
+flag indicating the requested APIs object is just
+            needed for a preparation process
 </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>

eric ide

mercurial