Updated source docu.

Thu, 11 Dec 2014 19:53:40 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 11 Dec 2014 19:53:40 +0100
changeset 3967
383a043d62ec
parent 3966
969a3d41c402
child 3968
19d287451e44

Updated source docu.

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.HgLogBrowserDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ProjectHelper.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelveBrowserDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Utilities.ClassBrowsers.ClbrBaseClasses.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Utilities.ClassBrowsers.pyclbr.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Utilities.ModuleParser.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.install.html file | annotate | diff | comparison | revisions
--- a/APIs/Python3/eric6.api	Thu Dec 11 19:51:05 2014 +0100
+++ b/APIs/Python3/eric6.api	Thu Dec 11 19:53:40 2014 +0100
@@ -8372,7 +8372,7 @@
 eric6.Utilities.ClassBrowsers.ClbrBaseClasses.Function.Class?7
 eric6.Utilities.ClassBrowsers.ClbrBaseClasses.Function.General?7
 eric6.Utilities.ClassBrowsers.ClbrBaseClasses.Function.Static?7
-eric6.Utilities.ClassBrowsers.ClbrBaseClasses.Function?1(module, name, file, lineno, signature='', separator=', ', modifierType=General)
+eric6.Utilities.ClassBrowsers.ClbrBaseClasses.Function?1(module, name, file, lineno, signature='', separator=', ', modifierType=General, annotation="")
 eric6.Utilities.ClassBrowsers.ClbrBaseClasses.Module?1(module, name, file, lineno)
 eric6.Utilities.ClassBrowsers.ClbrBaseClasses._ClbrBase.setEndLine?4(endLineNo)
 eric6.Utilities.ClassBrowsers.ClbrBaseClasses._ClbrBase?2(module, name, file, lineno)
@@ -8409,7 +8409,7 @@
 eric6.Utilities.ClassBrowsers.jsclbr.readmodule_ex?4(module, path=[])
 eric6.Utilities.ClassBrowsers.pyclbr.Attribute?1(module, name, file, lineno)
 eric6.Utilities.ClassBrowsers.pyclbr.Class?1(module, name, super, file, lineno)
-eric6.Utilities.ClassBrowsers.pyclbr.Function?1(module, name, file, lineno, signature='', separator=', ', modifierType=ClbrBaseClasses.Function.General)
+eric6.Utilities.ClassBrowsers.pyclbr.Function?1(module, name, file, lineno, signature='', separator=', ', modifierType=ClbrBaseClasses.Function.General, annotation="")
 eric6.Utilities.ClassBrowsers.pyclbr.Publics?1(module, file, lineno, idents)
 eric6.Utilities.ClassBrowsers.pyclbr.SUPPORTED_TYPES?7
 eric6.Utilities.ClassBrowsers.pyclbr.TABWIDTH?7
@@ -8454,7 +8454,7 @@
 eric6.Utilities.ModuleParser.Function.Static?7
 eric6.Utilities.ModuleParser.Function.addDescription?4(description)
 eric6.Utilities.ModuleParser.Function.setEndLine?4(endLineNo)
-eric6.Utilities.ModuleParser.Function?1(module, name, file, lineno, signature='', pyqtSignature=None, modifierType=General)
+eric6.Utilities.ModuleParser.Function?1(module, name, file, lineno, signature='', pyqtSignature=None, modifierType=General, annotation="")
 eric6.Utilities.ModuleParser.Module.addClass?4(name, _class)
 eric6.Utilities.ModuleParser.Module.addDescription?4(description)
 eric6.Utilities.ModuleParser.Module.addFunction?4(name, function)
@@ -9034,6 +9034,7 @@
 eric6.install.compile_ui?4(ui_dir, ui_file)
 eric6.install.configLength?7
 eric6.install.configName?7
+eric6.install.copyDesktopFile?4(src, dst, marker)
 eric6.install.copyToFile?4(name, text)
 eric6.install.copyTree?4(src, dst, filters, excludeDirs=[], excludePatterns=[])
 eric6.install.createConfig?4()
@@ -9044,6 +9045,7 @@
 eric6.install.currDir?7
 eric6.install.defaultMacAppBundleName?7
 eric6.install.defaultMacAppBundlePath?7
+eric6.install.defaultMacPythonExe?7
 eric6.install.determinePyQtVariant?4()
 eric6.install.distDir?7
 eric6.install.doCleanup?7
@@ -9052,6 +9054,7 @@
 eric6.install.exit?4(rcode=0)
 eric6.install.includePythonVariant?7
 eric6.install.initGlobals?4()
+eric6.install.installApis?7
 eric6.install.installEric?4()
 eric6.install.macAppBundleName?7
 eric6.install.macAppBundlePath?7
@@ -9063,6 +9066,7 @@
 eric6.install.progName?7
 eric6.install.pyModDir?7
 eric6.install.pyName?4(py_dir, py_file)
+eric6.install.pyqtOverride?7
 eric6.install.pyqtVariant?7
 eric6.install.shutilCopy?4(src, dst, perm=0o644)
 eric6.install.sourceDir?7
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Help/source.qhp	Thu Dec 11 19:51:05 2014 +0100
+++ b/Documentation/Help/source.qhp	Thu Dec 11 19:53:40 2014 +0100
@@ -12933,6 +12933,7 @@
       <keyword name="continued_indentation" id="continued_indentation" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pep8.html#continued_indentation" />
       <keyword name="convertLineEnds" id="convertLineEnds" ref="eric6.Utilities.__init__.html#convertLineEnds" />
       <keyword name="convertPasswords" id="convertPasswords" ref="eric6.Preferences.__init__.html#convertPasswords" />
+      <keyword name="copyDesktopFile" id="copyDesktopFile" ref="eric6.install.html#copyDesktopFile" />
       <keyword name="copyToFile" id="copyToFile" ref="eric6.install.html#copyToFile" />
       <keyword name="copyTree" id="copyTree" ref="eric6.install.html#copyTree" />
       <keyword name="create" id="create" ref="eric6.Preferences.ConfigurationPages.ApplicationPage.html#create" />
--- a/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.html	Thu Dec 11 19:51:05 2014 +0100
+++ b/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.html	Thu Dec 11 19:53:40 2014 +0100
@@ -208,7 +208,7 @@
 <td>Private slot called, when a filter expression is entered.</td>
 </tr><tr>
 <td><a href="#HgLogBrowserDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
-<td>Private slot to send the input to the merurial process.</td>
+<td>Private slot to send the input to the mercurial process.</td>
 </tr><tr>
 <td><a href="#HgLogBrowserDialog.on_stopCheckBox_clicked">on_stopCheckBox_clicked</a></td>
 <td>Private slot called, when the stop on copy/move checkbox is clicked.</td>
@@ -732,7 +732,7 @@
 <h4>HgLogBrowserDialog.on_sendButton_clicked</h4>
 <b>on_sendButton_clicked</b>(<i></i>)
 <p>
-        Private slot to send the input to the merurial process.
+        Private slot to send the input to the mercurial process.
 </p><a NAME="HgLogBrowserDialog.on_stopCheckBox_clicked" ID="HgLogBrowserDialog.on_stopCheckBox_clicked"></a>
 <h4>HgLogBrowserDialog.on_stopCheckBox_clicked</h4>
 <b>on_stopCheckBox_clicked</b>(<i>checked</i>)
--- a/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ProjectHelper.html	Thu Dec 11 19:51:05 2014 +0100
+++ b/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ProjectHelper.html	Thu Dec 11 19:53:40 2014 +0100
@@ -136,7 +136,7 @@
 <td>Private slot used to edit the repository configuration file.</td>
 </tr><tr>
 <td><a href="#HgProjectHelper.__hgEditUserConfig">__hgEditUserConfig</a></td>
-<td>Private slot used to edit the repository configuration file.</td>
+<td>Private slot used to edit the user configuration file.</td>
 </tr><tr>
 <td><a href="#HgProjectHelper.__hgExport">__hgExport</a></td>
 <td>Private slot used to export revisions to patch files.</td>
@@ -414,7 +414,7 @@
 <h4>HgProjectHelper.__hgEditUserConfig</h4>
 <b>__hgEditUserConfig</b>(<i></i>)
 <p>
-        Private slot used to edit the repository configuration file.
+        Private slot used to edit the user configuration file.
 </p><a NAME="HgProjectHelper.__hgExport" ID="HgProjectHelper.__hgExport"></a>
 <h4>HgProjectHelper.__hgExport</h4>
 <b>__hgExport</b>(<i></i>)
--- a/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelveBrowserDialog.html	Thu Dec 11 19:51:05 2014 +0100
+++ b/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.HgShelveBrowserDialog.html	Thu Dec 11 19:53:40 2014 +0100
@@ -118,7 +118,7 @@
 <td>Private slot to refresh the list of shelves.</td>
 </tr><tr>
 <td><a href="#HgShelveBrowserDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
-<td>Private slot to send the input to the merurial process.</td>
+<td>Private slot to send the input to the mercurial process.</td>
 </tr><tr>
 <td><a href="#HgShelveBrowserDialog.on_shelveList_currentItemChanged">on_shelveList_currentItemChanged</a></td>
 <td>Private slot called, when the current item of the shelve list changes.</td>
@@ -309,7 +309,7 @@
 <h4>HgShelveBrowserDialog.on_sendButton_clicked</h4>
 <b>on_sendButton_clicked</b>(<i></i>)
 <p>
-        Private slot to send the input to the merurial process.
+        Private slot to send the input to the mercurial process.
 </p><a NAME="HgShelveBrowserDialog.on_shelveList_currentItemChanged" ID="HgShelveBrowserDialog.on_shelveList_currentItemChanged"></a>
 <h4>HgShelveBrowserDialog.on_shelveList_currentItemChanged</h4>
 <b>on_shelveList_currentItemChanged</b>(<i>current, previous</i>)
--- a/Documentation/Source/eric6.Utilities.ClassBrowsers.ClbrBaseClasses.html	Thu Dec 11 19:51:05 2014 +0100
+++ b/Documentation/Source/eric6.Utilities.ClassBrowsers.ClbrBaseClasses.html	Thu Dec 11 19:53:40 2014 +0100
@@ -498,7 +498,7 @@
 </table>
 <a NAME="Function.__init__" ID="Function.__init__"></a>
 <h4>Function (Constructor)</h4>
-<b>Function</b>(<i>module, name, file, lineno, signature='', separator=', ', modifierType=General</i>)
+<b>Function</b>(<i>module, name, file, lineno, signature='', separator=', ', modifierType=General, annotation=""</i>)
 <p>
         Constructor
 </p><dl>
@@ -523,6 +523,9 @@
 </dd><dt><i>modifierType</i></dt>
 <dd>
 type of the function
+</dd><dt><i>annotation</i></dt>
+<dd>
+return annotation
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric6.Utilities.ClassBrowsers.pyclbr.html	Thu Dec 11 19:51:05 2014 +0100
+++ b/Documentation/Source/eric6.Utilities.ClassBrowsers.pyclbr.html	Thu Dec 11 19:53:40 2014 +0100
@@ -189,7 +189,7 @@
 </table>
 <a NAME="Function.__init__" ID="Function.__init__"></a>
 <h4>Function (Constructor)</h4>
-<b>Function</b>(<i>module, name, file, lineno, signature='', separator=', ', modifierType=ClbrBaseClasses.Function.General</i>)
+<b>Function</b>(<i>module, name, file, lineno, signature='', separator=', ', modifierType=ClbrBaseClasses.Function.General, annotation=""</i>)
 <p>
         Constructor
 </p><dl>
@@ -214,6 +214,9 @@
 </dd><dt><i>modifierType</i></dt>
 <dd>
 type of the function
+</dd><dt><i>annotation</i></dt>
+<dd>
+return annotation
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric6.Utilities.ModuleParser.html	Thu Dec 11 19:51:05 2014 +0100
+++ b/Documentation/Source/eric6.Utilities.ModuleParser.html	Thu Dec 11 19:53:40 2014 +0100
@@ -342,7 +342,7 @@
 </table>
 <a NAME="Function.__init__" ID="Function.__init__"></a>
 <h4>Function (Constructor)</h4>
-<b>Function</b>(<i>module, name, file, lineno, signature='', pyqtSignature=None, modifierType=General</i>)
+<b>Function</b>(<i>module, name, file, lineno, signature='', pyqtSignature=None, modifierType=General, annotation=""</i>)
 <p>
         Constructor
 </p><dl>
@@ -367,6 +367,9 @@
 </dd><dt><i>modifierType</i></dt>
 <dd>
 type of the function
+</dd><dt><i>annotation</i></dt>
+<dd>
+return annotation
 </dd>
 </dl><a NAME="Function.addDescription" ID="Function.addDescription"></a>
 <h4>Function.addDescription</h4>
--- a/Documentation/Source/eric6.install.html	Thu Dec 11 19:51:05 2014 +0100
+++ b/Documentation/Source/eric6.install.html	Thu Dec 11 19:53:40 2014 +0100
@@ -25,7 +25,7 @@
 </p>
 <h3>Global Attributes</h3>
 <table>
-<tr><td>BlackLists</td></tr><tr><td>PlatformsBlackLists</td></tr><tr><td>PythonMarkers</td></tr><tr><td>apisDir</td></tr><tr><td>cfg</td></tr><tr><td>configLength</td></tr><tr><td>configName</td></tr><tr><td>currDir</td></tr><tr><td>defaultMacAppBundleName</td></tr><tr><td>defaultMacAppBundlePath</td></tr><tr><td>distDir</td></tr><tr><td>doCleanup</td></tr><tr><td>doCompile</td></tr><tr><td>includePythonVariant</td></tr><tr><td>macAppBundleName</td></tr><tr><td>macAppBundlePath</td></tr><tr><td>macPythonExe</td></tr><tr><td>modDir</td></tr><tr><td>platBinDir</td></tr><tr><td>progLanguages</td></tr><tr><td>progName</td></tr><tr><td>pyModDir</td></tr><tr><td>pyqtVariant</td></tr><tr><td>sourceDir</td></tr>
+<tr><td>BlackLists</td></tr><tr><td>PlatformsBlackLists</td></tr><tr><td>PythonMarkers</td></tr><tr><td>apisDir</td></tr><tr><td>cfg</td></tr><tr><td>configLength</td></tr><tr><td>configName</td></tr><tr><td>currDir</td></tr><tr><td>defaultMacAppBundleName</td></tr><tr><td>defaultMacAppBundlePath</td></tr><tr><td>defaultMacPythonExe</td></tr><tr><td>distDir</td></tr><tr><td>doCleanup</td></tr><tr><td>doCompile</td></tr><tr><td>includePythonVariant</td></tr><tr><td>installApis</td></tr><tr><td>macAppBundleName</td></tr><tr><td>macAppBundlePath</td></tr><tr><td>macPythonExe</td></tr><tr><td>modDir</td></tr><tr><td>platBinDir</td></tr><tr><td>progLanguages</td></tr><tr><td>progName</td></tr><tr><td>pyModDir</td></tr><tr><td>pyqtOverride</td></tr><tr><td>pyqtVariant</td></tr><tr><td>sourceDir</td></tr>
 </table>
 <h3>Classes</h3>
 <table>
@@ -49,6 +49,9 @@
 <td><a href="#compile_ui">compile_ui</a></td>
 <td>Local function to compile a single .ui file.</td>
 </tr><tr>
+<td><a href="#copyDesktopFile">copyDesktopFile</a></td>
+<td>Modify a desktop file and write it to its destination.</td>
+</tr><tr>
 <td><a href="#copyToFile">copyToFile</a></td>
 <td>Copy a string to a file.</td>
 </tr><tr>
@@ -183,6 +186,25 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
+<a NAME="copyDesktopFile" ID="copyDesktopFile"></a>
+<h2>copyDesktopFile</h2>
+<b>copyDesktopFile</b>(<i>src, dst, marker</i>)
+<p>
+    Modify a desktop file and write it to its destination.
+</p><dl>
+<dt><i>src</i></dt>
+<dd>
+source file name (string)
+</dd><dt><i>dst</i></dt>
+<dd>
+destination file name (string)
+</dd><dt><i>marker</i></dt>
+<dd>
+marker to be used (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
 <a NAME="copyToFile" ID="copyToFile"></a>
 <h2>copyToFile</h2>
 <b>copyToFile</b>(<i>name, text</i>)

eric ide

mercurial