Eric Assistant: comparison AssistantEric/Documentation/source/Plugin_Assistant

-:b447f89da620
+:67197c1f11eb
 </dd>
 </dl><a NAME="APIsManager.__apiPreparationCancelled" ID="APIsManager.__apiPreparationCancelled"></a>
 <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>
 language of the API (string)
 </dd>
 <b>getAPIs</b>(<i>language</i>)
 <p>
 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>
 the language of the requested api object (string)
 </dd>
 Class implementing an API storage entity.
 </p><h3>Signals</h3>
 <dl>
 <dt>apiPreparationStatus(language, status, file)</dt>
 <dd>
-emitted to indicate the
+emitted to indicate
-API preparation status for a language
+the API preparation status for a language
 </dd>
 </dl>
 <h3>Derived from</h3>
 QObject
 <h3>Class Attributes</h3>
 Private method to create an API database.
 </p><a NAME="DbAPIs.__enoughCommas" ID="DbAPIs.__enoughCommas"></a>
 <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>
 string to check (string)
 </dd><dt><i>commas</i></dt>
 <p>
 Private method to get the source files for the project forms.
 </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>
 <dd>
 list of project form sources (list of strings)
 <dt><i>acWord</i></dt>
 <dd>
 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)
 </dd><dt><i>fullContext</i></dt>
 <dd>
 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
 base classes (boolean)
 </dd>
 base classes (boolean)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-list of dictionaries with possible completions (key 'completion'
+list of dictionaries with possible completions
-contains the completion (string), key 'context'
+(key 'completion' contains the completion (string),
-contains the context (string) and key 'pictureId'
+key 'context' contains the context (string) and
-contains the ID of the icon to be shown (string))
+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>
 <b>getLexer</b>(<i></i>)
 <p>
 <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>
 <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>
 <b>__autoCompletionWordSeparators</b>(<i>language</i>)
 <p>
 <h4>DbAPIsWorker.__storeFileInfoOnly</h4>
 <b>__storeFileInfoOnly</b>(<i>apiFile</i>)
 <p>
 Private method to store file info only.
 </p><p>
-Doing this avoids rereading the file whenever the API is initialized in case
+Doing this avoids rereading the file whenever the API is initialized
-the given file doesn't contain API data.
+in case the given file doesn't contain API data.
-</p><a NAME="DbAPIsWorker.abort" ID="DbAPIsWorker.abort"></a>
+</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>
 Public method to ask the thread to stop.
 </p><a NAME="DbAPIsWorker.run" ID="DbAPIsWorker.run"></a>

Mercurial Repositories > Eric Assistant / file comparison

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

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