Corrected a source docu issue and regenerated the source docu files. APIs

Thu, 01 Dec 2016 19:22:06 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 01 Dec 2016 19:22:06 +0100
branch
APIs
changeset 5352
ddcf6fd8c316
parent 5351
e87b1fec71d1
child 5358
2584d0a08bf4

Corrected a source docu issue and regenerated the source docu files.

APIs/Python3/eric6.api file | annotate | diff | comparison | revisions
Documentation/Help/source.qch file | annotate | diff | comparison | revisions
Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgTagDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Preferences.ConfigurationPages.EditorAPIsPage.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Preferences.__init__.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Project.Project.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.QScintilla.APIsManager.html file | annotate | diff | comparison | revisions
Project/Project.py file | annotate | diff | comparison | revisions
--- a/APIs/Python3/eric6.api	Thu Dec 01 19:18:56 2016 +0100
+++ b/APIs/Python3/eric6.api	Thu Dec 01 19:22:06 2016 +0100
@@ -6249,6 +6249,7 @@
 eric6.Preferences.ConfigurationPages.EditorAPIsPage.EditorAPIsPage.on_apiList_itemSelectionChanged?4()
 eric6.Preferences.ConfigurationPages.EditorAPIsPage.EditorAPIsPage.on_deleteApiFileButton_clicked?4()
 eric6.Preferences.ConfigurationPages.EditorAPIsPage.EditorAPIsPage.on_prepareApiButton_clicked?4()
+eric6.Preferences.ConfigurationPages.EditorAPIsPage.EditorAPIsPage.on_projectTypeComboBox_activated?4(index)
 eric6.Preferences.ConfigurationPages.EditorAPIsPage.EditorAPIsPage.save?4()
 eric6.Preferences.ConfigurationPages.EditorAPIsPage.EditorAPIsPage.saveState?4()
 eric6.Preferences.ConfigurationPages.EditorAPIsPage.EditorAPIsPage.setState?4(state)
@@ -6633,7 +6634,7 @@
 eric6.Preferences.getCorba?4(key, prefClass=Prefs)
 eric6.Preferences.getDebugger?4(key, prefClass=Prefs)
 eric6.Preferences.getEditor?4(key, prefClass=Prefs)
-eric6.Preferences.getEditorAPI?4(key, prefClass=Prefs)
+eric6.Preferences.getEditorAPI?4(language, projectType="", prefClass=Prefs)
 eric6.Preferences.getEditorColour?4(key, prefClass=Prefs)
 eric6.Preferences.getEditorExporter?4(key, prefClass=Prefs)
 eric6.Preferences.getEditorKeywords?4(key, prefClass=Prefs)
@@ -6686,7 +6687,7 @@
 eric6.Preferences.setCorba?4(key, value, prefClass=Prefs)
 eric6.Preferences.setDebugger?4(key, value, prefClass=Prefs)
 eric6.Preferences.setEditor?4(key, value, prefClass=Prefs)
-eric6.Preferences.setEditorAPI?4(key, apilist, prefClass=Prefs)
+eric6.Preferences.setEditorAPI?4(language, projectType, apilist, prefClass=Prefs)
 eric6.Preferences.setEditorColour?4(key, value, prefClass=Prefs)
 eric6.Preferences.setEditorExporter?4(key, value, prefClass=Prefs)
 eric6.Preferences.setEditorKeywords?4(key, keywordsLists, prefClass=Prefs)
@@ -7178,8 +7179,8 @@
 eric6.QScintilla.APIsManager.APIs.isEmpty?4()
 eric6.QScintilla.APIsManager.APIs.prepareAPIs?4(ondemand=False, rawList=None)
 eric6.QScintilla.APIsManager.APIs.reloadAPIs?4()
-eric6.QScintilla.APIsManager.APIs?1(language, forPreparation=False, parent=None)
-eric6.QScintilla.APIsManager.APIsManager.getAPIs?4(language, forPreparation=False)
+eric6.QScintilla.APIsManager.APIs?1(language, projectType="", forPreparation=False, parent=None)
+eric6.QScintilla.APIsManager.APIsManager.getAPIs?4(language, projectType="", forPreparation=False)
 eric6.QScintilla.APIsManager.APIsManager.reloadAPIs?4()
 eric6.QScintilla.APIsManager.APIsManager?1(parent=None)
 eric6.QScintilla.Editor.Editor.AttributeID?7
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Help/source.qhp	Thu Dec 01 19:18:56 2016 +0100
+++ b/Documentation/Help/source.qhp	Thu Dec 01 19:22:06 2016 +0100
@@ -1370,8 +1370,8 @@
       <keyword name="APIs.__apiPreparationCancelled" id="APIs.__apiPreparationCancelled" ref="eric6.QScintilla.APIsManager.html#APIs.__apiPreparationCancelled" />
       <keyword name="APIs.__apiPreparationFinished" id="APIs.__apiPreparationFinished" ref="eric6.QScintilla.APIsManager.html#APIs.__apiPreparationFinished" />
       <keyword name="APIs.__apiPreparationStarted" id="APIs.__apiPreparationStarted" ref="eric6.QScintilla.APIsManager.html#APIs.__apiPreparationStarted" />
-      <keyword name="APIs.__defaultPreparedName" id="APIs.__defaultPreparedName" ref="eric6.QScintilla.APIsManager.html#APIs.__defaultPreparedName" />
       <keyword name="APIs.__loadAPIs" id="APIs.__loadAPIs" ref="eric6.QScintilla.APIsManager.html#APIs.__loadAPIs" />
+      <keyword name="APIs.__preparedName" id="APIs.__preparedName" ref="eric6.QScintilla.APIsManager.html#APIs.__preparedName" />
       <keyword name="APIs.cancelPreparation" id="APIs.cancelPreparation" ref="eric6.QScintilla.APIsManager.html#APIs.cancelPreparation" />
       <keyword name="APIs.getQsciAPIs" id="APIs.getQsciAPIs" ref="eric6.QScintilla.APIsManager.html#APIs.getQsciAPIs" />
       <keyword name="APIs.installedAPIFiles" id="APIs.installedAPIFiles" ref="eric6.QScintilla.APIsManager.html#APIs.installedAPIFiles" />
@@ -5163,10 +5163,12 @@
       <keyword name="EditorAPIsPage" id="EditorAPIsPage" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage" />
       <keyword name="EditorAPIsPage (Constructor)" id="EditorAPIsPage (Constructor)" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.__init__" />
       <keyword name="EditorAPIsPage (Module)" id="EditorAPIsPage (Module)" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html" />
+      <keyword name="EditorAPIsPage.__apiKey" id="EditorAPIsPage.__apiKey" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.__apiKey" />
       <keyword name="EditorAPIsPage.__apiPreparationCancelled" id="EditorAPIsPage.__apiPreparationCancelled" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.__apiPreparationCancelled" />
       <keyword name="EditorAPIsPage.__apiPreparationFinished" id="EditorAPIsPage.__apiPreparationFinished" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.__apiPreparationFinished" />
       <keyword name="EditorAPIsPage.__apiPreparationStarted" id="EditorAPIsPage.__apiPreparationStarted" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.__apiPreparationStarted" />
       <keyword name="EditorAPIsPage.__editorGetApisFromApiList" id="EditorAPIsPage.__editorGetApisFromApiList" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.__editorGetApisFromApiList" />
+      <keyword name="EditorAPIsPage.__fillApisList" id="EditorAPIsPage.__fillApisList" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.__fillApisList" />
       <keyword name="EditorAPIsPage.on_addApiFileButton_clicked" id="EditorAPIsPage.on_addApiFileButton_clicked" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.on_addApiFileButton_clicked" />
       <keyword name="EditorAPIsPage.on_addInstalledApiFileButton_clicked" id="EditorAPIsPage.on_addInstalledApiFileButton_clicked" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.on_addInstalledApiFileButton_clicked" />
       <keyword name="EditorAPIsPage.on_addPluginApiFileButton_clicked" id="EditorAPIsPage.on_addPluginApiFileButton_clicked" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.on_addPluginApiFileButton_clicked" />
@@ -5175,6 +5177,7 @@
       <keyword name="EditorAPIsPage.on_apiList_itemSelectionChanged" id="EditorAPIsPage.on_apiList_itemSelectionChanged" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.on_apiList_itemSelectionChanged" />
       <keyword name="EditorAPIsPage.on_deleteApiFileButton_clicked" id="EditorAPIsPage.on_deleteApiFileButton_clicked" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.on_deleteApiFileButton_clicked" />
       <keyword name="EditorAPIsPage.on_prepareApiButton_clicked" id="EditorAPIsPage.on_prepareApiButton_clicked" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.on_prepareApiButton_clicked" />
+      <keyword name="EditorAPIsPage.on_projectTypeComboBox_activated" id="EditorAPIsPage.on_projectTypeComboBox_activated" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.on_projectTypeComboBox_activated" />
       <keyword name="EditorAPIsPage.save" id="EditorAPIsPage.save" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.save" />
       <keyword name="EditorAPIsPage.saveState" id="EditorAPIsPage.saveState" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.saveState" />
       <keyword name="EditorAPIsPage.setState" id="EditorAPIsPage.setState" ref="eric6.Preferences.ConfigurationPages.EditorAPIsPage.html#EditorAPIsPage.setState" />
--- a/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgTagDialog.html	Thu Dec 01 19:18:56 2016 +0100
+++ b/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgTagDialog.html	Thu Dec 01 19:22:06 2016 +0100
@@ -101,7 +101,13 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-tuple of two strings and int (tag, revision, tag operation)
+tuple containing the tag, revision, tag operation and a flag
+            indicating to enforce the operation
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of str, str, int,bool
 </dd>
 </dl><a NAME="HgTagDialog.on_tagCombo_currentIndexChanged" ID="HgTagDialog.on_tagCombo_currentIndexChanged"></a>
 <h4>HgTagDialog.on_tagCombo_currentIndexChanged</h4>
--- a/Documentation/Source/eric6.Preferences.ConfigurationPages.EditorAPIsPage.html	Thu Dec 01 19:18:56 2016 +0100
+++ b/Documentation/Source/eric6.Preferences.ConfigurationPages.EditorAPIsPage.html	Thu Dec 01 19:22:06 2016 +0100
@@ -63,6 +63,9 @@
 <td><a href="#EditorAPIsPage.__init__">EditorAPIsPage</a></td>
 <td>Constructor</td>
 </tr><tr>
+<td><a href="#EditorAPIsPage.__apiKey">__apiKey</a></td>
+<td>Private method to generate a key for the apis dictionary.</td>
+</tr><tr>
 <td><a href="#EditorAPIsPage.__apiPreparationCancelled">__apiPreparationCancelled</a></td>
 <td>Private slot called after the API preparation has been cancelled.</td>
 </tr><tr>
@@ -75,6 +78,9 @@
 <td><a href="#EditorAPIsPage.__editorGetApisFromApiList">__editorGetApisFromApiList</a></td>
 <td>Private slot to retrieve the api filenames from the list.</td>
 </tr><tr>
+<td><a href="#EditorAPIsPage.__fillApisList">__fillApisList</a></td>
+<td>Private slot to fill the list of API files.</td>
+</tr><tr>
 <td><a href="#EditorAPIsPage.on_addApiFileButton_clicked">on_addApiFileButton_clicked</a></td>
 <td>Private slot to add the api file displayed to the listbox.</td>
 </tr><tr>
@@ -99,6 +105,9 @@
 <td><a href="#EditorAPIsPage.on_prepareApiButton_clicked">on_prepareApiButton_clicked</a></td>
 <td>Private slot to prepare the API file for the currently selected language.</td>
 </tr><tr>
+<td><a href="#EditorAPIsPage.on_projectTypeComboBox_activated">on_projectTypeComboBox_activated</a></td>
+<td>Private slot to handle the selection of a project type.</td>
+</tr><tr>
 <td><a href="#EditorAPIsPage.save">save</a></td>
 <td>Public slot to save the Editor APIs configuration.</td>
 </tr><tr>
@@ -118,7 +127,30 @@
 <b>EditorAPIsPage</b>(<i></i>)
 <p>
         Constructor
-</p><a NAME="EditorAPIsPage.__apiPreparationCancelled" ID="EditorAPIsPage.__apiPreparationCancelled"></a>
+</p><a NAME="EditorAPIsPage.__apiKey" ID="EditorAPIsPage.__apiKey"></a>
+<h4>EditorAPIsPage.__apiKey</h4>
+<b>__apiKey</b>(<i>language, projectType</i>)
+<p>
+        Private method to generate a key for the apis dictionary.
+</p><dl>
+<dt><i>language</i> (str)</dt>
+<dd>
+programming language of the API
+</dd><dt><i>projectType</i> (str)</dt>
+<dd>
+project type of the API
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+key to be used
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl><a NAME="EditorAPIsPage.__apiPreparationCancelled" ID="EditorAPIsPage.__apiPreparationCancelled"></a>
 <h4>EditorAPIsPage.__apiPreparationCancelled</h4>
 <b>__apiPreparationCancelled</b>(<i></i>)
 <p>
@@ -143,7 +175,12 @@
 <dd>
 list of api filenames (list of strings)
 </dd>
-</dl><a NAME="EditorAPIsPage.on_addApiFileButton_clicked" ID="EditorAPIsPage.on_addApiFileButton_clicked"></a>
+</dl><a NAME="EditorAPIsPage.__fillApisList" ID="EditorAPIsPage.__fillApisList"></a>
+<h4>EditorAPIsPage.__fillApisList</h4>
+<b>__fillApisList</b>(<i></i>)
+<p>
+        Private slot to fill the list of API files.
+</p><a NAME="EditorAPIsPage.on_addApiFileButton_clicked" ID="EditorAPIsPage.on_addApiFileButton_clicked"></a>
 <h4>EditorAPIsPage.on_addApiFileButton_clicked</h4>
 <b>on_addApiFileButton_clicked</b>(<i></i>)
 <p>
@@ -196,7 +233,17 @@
 <p>
         Private slot to prepare the API file for the currently selected
             language.
-</p><a NAME="EditorAPIsPage.save" ID="EditorAPIsPage.save"></a>
+</p><a NAME="EditorAPIsPage.on_projectTypeComboBox_activated" ID="EditorAPIsPage.on_projectTypeComboBox_activated"></a>
+<h4>EditorAPIsPage.on_projectTypeComboBox_activated</h4>
+<b>on_projectTypeComboBox_activated</b>(<i>index</i>)
+<p>
+        Private slot to handle the selection of a project type.
+</p><dl>
+<dt><i>index</i> (str)</dt>
+<dd>
+index of the selected entry
+</dd>
+</dl><a NAME="EditorAPIsPage.save" ID="EditorAPIsPage.save"></a>
 <h4>EditorAPIsPage.save</h4>
 <b>save</b>(<i></i>)
 <p>
@@ -209,7 +256,13 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-index of the selected lexer language (integer)
+tuple containing the index of the selected lexer language
+            and the index of the selected project type
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of int and int
 </dd>
 </dl><a NAME="EditorAPIsPage.setState" ID="EditorAPIsPage.setState"></a>
 <h4>EditorAPIsPage.setState</h4>
--- 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>
--- a/Documentation/Source/eric6.Project.Project.html	Thu Dec 01 19:18:56 2016 +0100
+++ b/Documentation/Source/eric6.Project.Project.html	Thu Dec 01 19:22:06 2016 +0100
@@ -1780,6 +1780,11 @@
 <dd>
 list of str
 </dd>
+</dl><dl>
+<dt>Raises <b>ValueError</b>:</dt>
+<dd>
+raised when an unsupported file type is given
+</dd>
 </dl><a NAME="Project.getProjectLanguage" ID="Project.getProjectLanguage"></a>
 <h4>Project.getProjectLanguage</h4>
 <b>getProjectLanguage</b>(<i></i>)
--- 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>
--- a/Project/Project.py	Thu Dec 01 19:18:56 2016 +0100
+++ b/Project/Project.py	Thu Dec 01 19:22:06 2016 +0100
@@ -3094,6 +3094,7 @@
         @type boolean
         @return list of file names
         @rtype list of str
+        @exception ValueError raised when an unsupported file type is given
         """
         if fileType not in ["SOURCES", "FORMS", "RESOURCES", "INTERFACES",
                             "OTHERS", "TRANSLATIONS"]:

eric ide

mercurial