AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.APIsManager.html

changeset 84
67197c1f11eb
parent 74
9ac338de7a2b
child 86
11088ce2312f
--- a/AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.APIsManager.html	Sun Oct 13 18:32:15 2013 +0200
+++ b/AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.APIsManager.html	Thu Oct 24 19:04:41 2013 +0200
@@ -113,7 +113,8 @@
 <h4>APIsManager.__apiPreparationCancelled</h4>
 <b>__apiPreparationCancelled</b>(<i>language</i>)
 <p>
-        Private slot handling the preparation cancelled signal of an API object.
+        Private slot handling the preparation cancelled signal of an API
+        object.
 </p><dl>
 <dt><i>language</i></dt>
 <dd>
@@ -177,7 +178,8 @@
         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.
+        This saves memory for languages, that might not be needed at the
+        moment.
 </p><dl>
 <dt><i>language</i></dt>
 <dd>
@@ -204,8 +206,8 @@
 <dl>
 <dt>apiPreparationStatus(language, status, file)</dt>
 <dd>
-emitted to indicate the
-            API preparation status for a language
+emitted to indicate
+        the API preparation status for a language
 </dd>
 </dl>
 <h3>Derived from</h3>
@@ -320,7 +322,8 @@
 <h4>DbAPIs.__enoughCommas</h4>
 <b>__enoughCommas</b>(<i>s, commas</i>)
 <p>
-        Private method to determine, if the given string contains enough commas.
+        Private method to determine, if the given string contains enough
+        commas.
 </p><dl>
 <dt><i>s</i></dt>
 <dd>
@@ -342,7 +345,8 @@
 </p><dl>
 <dt><i>normalized=</i></dt>
 <dd>
-flag indicating a normalized filename is wanted (boolean)
+flag indicating a normalized filename is wanted
+            (boolean)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
@@ -479,7 +483,8 @@
 function to get calltips for (string)
 </dd><dt><i>commas</i></dt>
 <dd>
-minimum number of commas contained in the calltip (integer)
+minimum number of commas contained in the calltip
+            (integer)
 </dd><dt><i>context</i></dt>
 <dd>
 string giving the context (e.g. classname) (string)
@@ -488,7 +493,8 @@
 string giving the full context (string)
 </dd><dt><i>showContext</i></dt>
 <dd>
-flag indicating to show the calltip context (boolean)
+flag indicating to show the calltip context
+            (boolean)
 </dd><dt><i>followHierarchy=</i></dt>
 <dd>
 flag indicating to follow the hierarchy of
@@ -521,10 +527,10 @@
 </dl><dl>
 <dt>Returns:</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))
+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))
 </dd>
 </dl><a NAME="DbAPIs.getLexer" ID="DbAPIs.getLexer"></a>
 <h4>DbAPIs.getLexer</h4>
@@ -630,7 +636,8 @@
             are extracted out of the sources of a project. (string)
 </dd><dt><i>refresh</i></dt>
 <dd>
-flag indicating a refresh of the APIs of one file (boolean)
+flag indicating a refresh of the APIs of one file
+            (boolean)
 </dd>
 </dl><a NAME="DbAPIsWorker.__autoCompletionWordSeparators" ID="DbAPIsWorker.__autoCompletionWordSeparators"></a>
 <h4>DbAPIsWorker.__autoCompletionWordSeparators</h4>
@@ -718,9 +725,14 @@
 <p>
         Private method to store file info only.
 </p><p>
-        Doing this avoids rereading the file whenever the API is initialized in case
-        the given file doesn't contain API data.
-</p><a NAME="DbAPIsWorker.abort" ID="DbAPIsWorker.abort"></a>
+        Doing this avoids rereading the file whenever the API is initialized
+        in case the given file doesn't contain API data.
+</p><dl>
+<dt><i>apiFile</i></dt>
+<dd>
+file name of the API file (string)
+</dd>
+</dl><a NAME="DbAPIsWorker.abort" ID="DbAPIsWorker.abort"></a>
 <h4>DbAPIsWorker.abort</h4>
 <b>abort</b>(<i></i>)
 <p>

eric ide

mercurial