Documentation/Source/eric6.Preferences.__init__.html

branch
APIs
changeset 5352
ddcf6fd8c316
parent 4918
71caf42a13d8
child 5765
39d8b26ff557
diff -r e87b1fec71d1 -r ddcf6fd8c316 Documentation/Source/eric6.Preferences.__init__.html
--- a/Documentation/Source/eric6.Preferences.__init__.html	Thu Dec 01 19:18:56 2016 +0100
+++ b/Documentation/Source/eric6.Preferences.__init__.html	Thu Dec 01 19:22:06 2016 +0100
@@ -65,7 +65,7 @@
 <td>Module function to retrieve the various editor settings.</td>
 </tr><tr>
 <td><a href="#getEditorAPI">getEditorAPI</a></td>
-<td>Module function to retrieve the various lists of api files.</td>
+<td>Module function to retrieve the various lists of API files.</td>
 </tr><tr>
 <td><a href="#getEditorColour">getEditorColour</a></td>
 <td>Module function to retrieve the various editor marker colours.</td>
@@ -224,7 +224,7 @@
 <td>Module function to store the various editor settings.</td>
 </tr><tr>
 <td><a href="#setEditorAPI">setEditorAPI</a></td>
-<td>Module function to store the various lists of api files.</td>
+<td>Module function to store the various lists of API files.</td>
 </tr><tr>
 <td><a href="#setEditorColour">setEditorColour</a></td>
 <td>Module function to store the various editor marker colours.</td>
@@ -514,21 +514,29 @@
 <hr /><hr />
 <a NAME="getEditorAPI" ID="getEditorAPI"></a>
 <h2>getEditorAPI</h2>
-<b>getEditorAPI</b>(<i>key, prefClass=Prefs</i>)
+<b>getEditorAPI</b>(<i>language, projectType="", prefClass=Prefs</i>)
 <p>
-    Module function to retrieve the various lists of api files.
+    Module function to retrieve the various lists of API files.
 </p><dl>
-<dt><i>key</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-the key of the value to get
-</dd><dt><i>prefClass</i></dt>
+language of the API list
+</dd><dt><i>projectType</i> (str)</dt>
+<dd>
+project type of the API list
+</dd><dt><i>prefClass</i> (Prefs)</dt>
 <dd>
 preferences class used as the storage area
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-the requested list of api files (list of strings)
+requested list of API files
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -1541,17 +1549,20 @@
 <hr /><hr />
 <a NAME="setEditorAPI" ID="setEditorAPI"></a>
 <h2>setEditorAPI</h2>
-<b>setEditorAPI</b>(<i>key, apilist, prefClass=Prefs</i>)
+<b>setEditorAPI</b>(<i>language, projectType, apilist, prefClass=Prefs</i>)
 <p>
-    Module function to store the various lists of api files.
+    Module function to store the various lists of API files.
 </p><dl>
-<dt><i>key</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-the key of the api to be set
-</dd><dt><i>apilist</i></dt>
+language of the API list
+</dd><dt><i>projectType</i> (str)</dt>
 <dd>
-the list of api files (list of strings)
-</dd><dt><i>prefClass</i></dt>
+project type of the API list
+</dd><dt><i>apilist</i> (list of str)</dt>
+<dd>
+list of API files
+</dd><dt><i>prefClass</i> (Prefs)</dt>
 <dd>
 preferences class used as the storage area
 </dd>

eric ide

mercurial