Fixed a source docu issue.

Sat, 13 May 2017 16:34:04 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 13 May 2017 16:34:04 +0200
changeset 5737
6820ae39114e
parent 5736
000ea446ff4b
child 5738
912d7ba40c26

Fixed a source docu issue.

Documentation/Help/source.qch file | annotate | diff | comparison | revisions
Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Globals.__init__.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.eric6_browser.html file | annotate | diff | comparison | revisions
Plugins/CheckerPlugins/CodeStyleChecker/CodeStyleChecker.py file | annotate | diff | comparison | revisions
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Help/source.qhp	Sat May 13 16:32:54 2017 +0200
+++ b/Documentation/Help/source.qhp	Sat May 13 16:34:04 2017 +0200
@@ -16977,6 +16977,7 @@
       <keyword name="python_3000_has_key" id="python_3000_has_key" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#python_3000_has_key" />
       <keyword name="python_3000_not_equal" id="python_3000_not_equal" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#python_3000_not_equal" />
       <keyword name="python_3000_raise_comma" id="python_3000_raise_comma" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#python_3000_raise_comma" />
+      <keyword name="qVersionTuple" id="qVersionTuple" ref="eric6.Globals.__init__.html#qVersionTuple" />
       <keyword name="qtHandler" id="qtHandler" ref="eric6.E5Gui.E5ErrorMessage.html#qtHandler" />
       <keyword name="question" id="question" ref="eric6.E5Gui.E5MessageBox.html#question" />
       <keyword name="queues (Module)" id="queues (Module)" ref="eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html" />
@@ -17148,6 +17149,7 @@
       <keyword name="version" id="version" ref="eric6.Toolbox.Startup.html#version" />
       <keyword name="version" id="version" ref="eric6.eric6_api.html#version" />
       <keyword name="version" id="version" ref="eric6.eric6_doc.html#version" />
+      <keyword name="versionToTuple" id="versionToTuple" ref="eric6.Globals.__init__.html#versionToTuple" />
       <keyword name="warning" id="warning" ref="eric6.E5Gui.E5MessageBox.html#warning" />
       <keyword name="whitespace_around_comma" id="whitespace_around_comma" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#whitespace_around_comma" />
       <keyword name="whitespace_around_keywords" id="whitespace_around_keywords" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#whitespace_around_keywords" />
--- a/Documentation/Source/eric6.Globals.__init__.html	Sat May 13 16:32:54 2017 +0200
+++ b/Documentation/Source/eric6.Globals.__init__.html	Sat May 13 16:34:04 2017 +0200
@@ -64,6 +64,9 @@
 <td><a href="#isWindowsPlatform">isWindowsPlatform</a></td>
 <td>Function to check, if this is a Windows platform.</td>
 </tr><tr>
+<td><a href="#qVersionTuple">qVersionTuple</a></td>
+<td>Module function to get the Qt version as a tuple.</td>
+</tr><tr>
 <td><a href="#setConfigDir">setConfigDir</a></td>
 <td>Module function to set the name of the directory storing the config data.</td>
 </tr><tr>
@@ -84,6 +87,9 @@
 </tr><tr>
 <td><a href="#translate">translate</a></td>
 <td>Module function to handle different PyQt 4/5 QCoreApplication.translate parameter.</td>
+</tr><tr>
+<td><a href="#versionToTuple">versionToTuple</a></td>
+<td>Module function to convert a version string into a tuple.</td>
 </tr>
 </table>
 <hr /><hr />
@@ -232,6 +238,24 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
+<a NAME="qVersionTuple" ID="qVersionTuple"></a>
+<h2>qVersionTuple</h2>
+<b>qVersionTuple</b>(<i></i>)
+<p>
+    Module function to get the Qt version as a tuple.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+Qt version as a tuple
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of int
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
 <a NAME="setConfigDir" ID="setConfigDir"></a>
 <h2>setConfigDir</h2>
 <b>setConfigDir</b>(<i>d</i>)
@@ -365,5 +389,32 @@
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="versionToTuple" ID="versionToTuple"></a>
+<h2>versionToTuple</h2>
+<b>versionToTuple</b>(<i>version</i>)
+<p>
+    Module function to convert a version string into a tuple.
+</p><p>
+    Note: A version string consists of non-negative decimals separated by "."
+    optionally followed by a suffix. Suffix is everything after the last
+    decimal.
+</p><dl>
+<dt><i>version</i> (str)</dt>
+<dd>
+version string
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+version tuple without the suffix
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of int
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file
--- a/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html	Sat May 13 16:32:54 2017 +0200
+++ b/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html	Sat May 13 16:34:04 2017 +0200
@@ -259,6 +259,16 @@
 <dd>
 list of line flags to check against
 </dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating to ignore the code
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
--- a/Documentation/Source/eric6.eric6_browser.html	Sat May 13 16:32:54 2017 +0200
+++ b/Documentation/Source/eric6.eric6_browser.html	Sat May 13 16:34:04 2017 +0200
@@ -29,7 +29,7 @@
 </p>
 <h3>Global Attributes</h3>
 <table>
-<tr><td>MIN_QT_VERSION</td></tr><tr><td>SettingsDir</td></tr>
+<tr><td>SettingsDir</td></tr>
 </table>
 <h3>Classes</h3>
 <table>
--- a/Plugins/CheckerPlugins/CodeStyleChecker/CodeStyleChecker.py	Sat May 13 16:32:54 2017 +0200
+++ b/Plugins/CheckerPlugins/CodeStyleChecker/CodeStyleChecker.py	Sat May 13 16:34:04 2017 +0200
@@ -114,6 +114,8 @@
     @type str
     @param lineFlags list of line flags to check against
     @type list of str
+    @return flag indicating to ignore the code
+    @rtype bool
     """
     if lineFlags:
         

eric ide

mercurial