Mercurial Repositories > eric / changeset
changeset
Fixed a few documentation strings that got broken while doing the line shortening job. That concludes the later.
Mon, 14 Oct 2013 18:26:25 +0200
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Mon, 14 Oct 2013 18:26:25 +0200
- changeset 3019
- 7912530a33e2
- parent 3018
- 70924c0bdaf1
- child 3020
- 542e97d4ecb3
Fixed a few documentation strings that got broken while doing the line shortening job. That concludes the later.
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.ProjectBrowserHelper.html Sun Oct 13 17:44:48 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.ProjectBrowserHelper.html Mon Oct 14 18:26:25 2013 +0200 @@ -106,7 +106,7 @@ <td>Private slot called by the context menu to show the difference of a file to the repository side-by-side.</td> </tr><tr> <td><a href="#SvnProjectBrowserHelper.__SVNSbsExtendedDiff">__SVNSbsExtendedDiff</a></td> -<td>Private slot called by the context menu to show the difference of a file to the repository side-by-side allowing the selection of revisions to compare.</td> +<td>Private slot called by the context menu to show the difference of a file to the repository side-by-side.</td> </tr><tr> <td><a href="#SvnProjectBrowserHelper.__SVNSetProp">__SVNSetProp</a></td> <td>Private slot called by the context menu to set a subversion property of a file.</td> @@ -272,8 +272,9 @@ <b>__SVNSbsExtendedDiff</b>(<i></i>) <p> Private slot called by the context menu to show the difference of a - file to the repository side-by-side allowing the selection of - revisions to compare. + file to the repository side-by-side. +</p><p> + It allows the selection of revisions to compare. </p><a NAME="SvnProjectBrowserHelper.__SVNSetProp" ID="SvnProjectBrowserHelper.__SVNSetProp"></a> <h4>SvnProjectBrowserHelper.__SVNSetProp</h4> <b>__SVNSetProp</b>(<i></i>)
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.ProjectBrowserHelper.html Sun Oct 13 17:44:48 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.ProjectBrowserHelper.html Mon Oct 14 18:26:25 2013 +0200 @@ -229,7 +229,7 @@ <b>__SVNLock</b>(<i></i>) <p> Private slot called by the context menu to lock files in the - repository. + repository. </p><a NAME="SvnProjectBrowserHelper.__SVNLogBrowser" ID="SvnProjectBrowserHelper.__SVNLogBrowser"></a> <h4>SvnProjectBrowserHelper.__SVNLogBrowser</h4> <b>__SVNLogBrowser</b>(<i></i>)
--- a/Documentation/Source/eric5.UI.FindFileNameDialog.html Sun Oct 13 17:44:48 2013 +0200 +++ b/Documentation/Source/eric5.UI.FindFileNameDialog.html Mon Oct 14 18:26:25 2013 +0200 @@ -236,8 +236,7 @@ <b>on_searchDirButton_clicked</b>(<i></i>) <p> Private slot to handle the clicked signal of the search directory - selection - button. + selection button. </p><a NAME="FindFileNameDialog.on_searchDirCheckBox_toggled" ID="FindFileNameDialog.on_searchDirCheckBox_toggled"></a> <h4>FindFileNameDialog.on_searchDirCheckBox_toggled</h4> <b>on_searchDirCheckBox_toggled</b>(<i>checked</i>)
--- a/Documentation/Source/eric5.Utilities.crypto.py3AES.html Sun Oct 13 17:44:48 2013 +0200 +++ b/Documentation/Source/eric5.Utilities.crypto.py3AES.html Mon Oct 14 18:26:25 2013 +0200 @@ -417,6 +417,11 @@ <dd> data of size 4 (bytearray) </dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +rotated data (bytearray) +</dd> </dl><a NAME="AES.__shiftRow" ID="AES.__shiftRow"></a> <h4>AES.__shiftRow</h4> <b>__shiftRow</b>(<i>state, statePointer, nbr, isInv</i>) @@ -501,6 +506,11 @@ <dd> decrypted data (bytes) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +key size is invalid +</dd> </dl><a NAME="AES.encrypt" ID="AES.encrypt"></a> <h4>AES.encrypt</h4> <b>encrypt</b>(<i>iput, key, size</i>) @@ -523,6 +533,11 @@ <dd> encrypted data (bytes) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +key size is invalid +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> @@ -588,9 +603,9 @@ <p> Public method to perform the decryption operation. </p><dl> -<dt><i>input</i></dt> +<dt><i>cipherIn</i></dt> <dd> -data to be encrypted (bytes) +data to be decrypted (bytes) </dd><dt><i>originalsize</i></dt> <dd> unencrypted string length (required for CBC) @@ -613,6 +628,11 @@ <dd> decrypted data (bytes) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +key size is invalid or decrypted data is invalid +</dd> </dl><a NAME="AESModeOfOperation.encrypt" ID="AESModeOfOperation.encrypt"></a> <h4>AESModeOfOperation.encrypt</h4> <b>encrypt</b>(<i>input, mode, key, size, IV</i>) @@ -641,6 +661,11 @@ tuple with mode of operation, length of the input and the encrypted data (integer, integer, bytes) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +key size is invalid or decrypted data is invalid +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> @@ -684,11 +709,6 @@ <dd> decrypted data (bytes) </dd> -</dl><dl> -<dt>Raises <b>ValueError</b>:</dt> -<dd> -key size is invalid or decrypted data is invalid -</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> @@ -731,6 +751,11 @@ <dd> stripped data (bytes) </dd> +</dl><dl> +<dt>Raises <b>ValueError</b>:</dt> +<dd> +data padding is invalid +</dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.ViewManager.ViewManager.html Sun Oct 13 17:44:48 2013 +0200 +++ b/Documentation/Source/eric5.ViewManager.ViewManager.html Mon Oct 14 18:26:25 2013 +0200 @@ -352,7 +352,7 @@ <td>Private method to send an editor command to the active window.</td> </tr><tr> <td><a href="#ViewManager.__editorConfigChanged">__editorConfigChanged</a></td> -<td>Private slot to handle changes of an editor's configuration (e.g.</td> +<td>Private slot to handle changes of an editor's configuration.</td> </tr><tr> <td><a href="#ViewManager.__editorOpened">__editorOpened</a></td> <td>Private slot to handle the editorOpened signal.</td> @@ -1234,8 +1234,7 @@ <h4>ViewManager.__editorConfigChanged</h4> <b>__editorConfigChanged</b>(<i></i>) <p> - Private slot to handle changes of an editor's configuration (e.g. - language). + Private slot to handle changes of an editor's configuration. </p><a NAME="ViewManager.__editorOpened" ID="ViewManager.__editorOpened"></a> <h4>ViewManager.__editorOpened</h4> <b>__editorOpened</b>(<i></i>)
--- a/Documentation/Source/eric5.eric5.html Sun Oct 13 17:44:48 2013 +0200 +++ b/Documentation/Source/eric5.eric5.html Mon Oct 14 18:26:25 2013 +0200 @@ -88,7 +88,13 @@ <b>main</b>(<i></i>) <p> Main entry point into the application. -</p> +</p><dl> +<dt>Raises <b>Exception</b>:</dt> +<dd> +re-raised for any exception occurring in the main + program logic +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="uiStartUp" ID="uiStartUp"></a>
--- a/Documentation/Source/eric5.install.html Sun Oct 13 17:44:48 2013 +0200 +++ b/Documentation/Source/eric5.install.html Mon Oct 14 18:26:25 2013 +0200 @@ -283,7 +283,12 @@ <b>exit</b>(<i>rcode=0</i>) <p> Exit the install script. -</p> +</p><dl> +<dt><i>rcode</i></dt> +<dd> +result code to report back (integer) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="initGlobals" ID="initGlobals"></a>
--- a/Documentation/Source/eric5.uninstall.html Sun Oct 13 17:44:48 2013 +0200 +++ b/Documentation/Source/eric5.uninstall.html Mon Oct 14 18:26:25 2013 +0200 @@ -59,7 +59,12 @@ <b>exit</b>(<i>rcode=0</i>) <p> Exit the uninstall script. -</p> +</p><dl> +<dt><i>rcode</i></dt> +<dd> +result code to report back (integer) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="initGlobals" ID="initGlobals"></a> @@ -75,9 +80,12 @@ <b>main</b>(<i>argv</i>) <p> The main function of the script. -</p><p> - argv is the list of command line arguments. -</p> +</p><dl> +<dt><i>argv</i></dt> +<dd> +list of command line arguments +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="uninstallEric" ID="uninstallEric"></a> @@ -93,9 +101,12 @@ <b>usage</b>(<i>rcode=2</i>) <p> Display a usage message and exit. -</p><p> - rcode is the return code passed back to the calling process. -</p> +</p><dl> +<dt><i>rcode</i></dt> +<dd> +return code passed back to the calling process (integer) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="wrapperName" ID="wrapperName"></a> @@ -103,7 +114,20 @@ <b>wrapperName</b>(<i>dname, wfile</i>) <p> Create the platform specific name for the wrapper script. -</p> +</p><dl> +<dt><i>dname</i></dt> +<dd> +name of the directory to place the wrapper into +</dd><dt><i>wfile</i></dt> +<dd> +basename (without extension) of the wrapper script +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the name of the wrapper script +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
--- a/Plugins/VcsPlugins/vcsPySvn/ProjectBrowserHelper.py Sun Oct 13 17:44:48 2013 +0200 +++ b/Plugins/VcsPlugins/vcsPySvn/ProjectBrowserHelper.py Mon Oct 14 18:26:25 2013 +0200 @@ -798,8 +798,9 @@ def __SVNSbsExtendedDiff(self): """ Private slot called by the context menu to show the difference of a - file to the repository side-by-side allowing the selection of - revisions to compare. + file to the repository side-by-side. + + It allows the selection of revisions to compare. """ itm = self.browser.currentItem() fn = itm.fileName()
--- a/Plugins/VcsPlugins/vcsSubversion/ProjectBrowserHelper.py Sun Oct 13 17:44:48 2013 +0200 +++ b/Plugins/VcsPlugins/vcsSubversion/ProjectBrowserHelper.py Mon Oct 14 18:26:25 2013 +0200 @@ -830,7 +830,8 @@ def __SVNLock(self): """ Private slot called by the context menu to lock files in the - repository. """ + repository. + """ names = [] for itm in self.browser.getSelectedItems(): try:
--- a/UI/FindFileNameDialog.py Sun Oct 13 17:44:48 2013 +0200 +++ b/UI/FindFileNameDialog.py Mon Oct 14 18:26:25 2013 +0200 @@ -194,8 +194,7 @@ def on_searchDirButton_clicked(self): """ Private slot to handle the clicked signal of the search directory - selection - button. + selection button. """ searchDir = E5FileDialog.getExistingDirectory( None,
--- a/Utilities/crypto/py3AES.py Sun Oct 13 17:44:48 2013 +0200 +++ b/Utilities/crypto/py3AES.py Mon Oct 14 18:26:25 2013 +0200 @@ -45,6 +45,7 @@ @param b data to be stripped (bytes) @return stripped data (bytes) + @exception ValueError data padding is invalid """ if len(b) % 16 or not b: raise ValueError( @@ -171,6 +172,7 @@ rotate(1d2c3a4f) == 2c3a4f1d. @param data data of size 4 (bytearray) + @return rotated data (bytearray) """ return data[1:] + data[:1] @@ -489,6 +491,7 @@ @param key key to be used (bytes or bytearray) @param size key size (16, 24 or 32) @return encrypted data (bytes) + @exception ValueError key size is invalid """ output = bytearray(16) # the number of rounds @@ -545,6 +548,7 @@ @param key key to be used (bytes or bytearray) @param size key size (16, 24 or 32) @return decrypted data (bytes) + @exception ValueError key size is invalid """ output = bytearray(16) # the number of rounds @@ -639,6 +643,7 @@ @param IV initialisation vector (bytearray) @return tuple with mode of operation, length of the input and the encrypted data (integer, integer, bytes) + @exception ValueError key size is invalid or decrypted data is invalid """ if len(key) % size: raise ValueError("Illegal size ({0}) for key '{1}'.".format( @@ -722,7 +727,7 @@ """ Public method to perform the decryption operation. - @param input data to be encrypted (bytes) + @param cipherIn data to be decrypted (bytes) @param originalsize unencrypted string length (required for CBC) (integer) @param mode mode of operation (0, 1 or 2) @@ -730,6 +735,7 @@ @param size length of the key (16, 24 or 32) @param IV initialisation vector (bytearray) @return decrypted data (bytes) + @exception ValueError key size is invalid or decrypted data is invalid """ if len(key) % size: raise ValueError("Illegal size ({0}) for key '{1}'.".format( @@ -840,7 +846,6 @@ (bytes) @param mode mode of operations (0, 1 or 2) @return decrypted data (bytes) - @exception ValueError key size is invalid or decrypted data is invalid """ key = bytearray(key) keysize = len(key)
--- a/ViewManager/ViewManager.py Sun Oct 13 17:44:48 2013 +0200 +++ b/ViewManager/ViewManager.py Mon Oct 14 18:26:25 2013 +0200 @@ -6227,8 +6227,7 @@ def __editorConfigChanged(self): """ - Private slot to handle changes of an editor's configuration (e.g. - language). + Private slot to handle changes of an editor's configuration. """ editor = self.sender() fn = editor.getFileName()
--- a/eric5.py Sun Oct 13 17:44:48 2013 +0200 +++ b/eric5.py Mon Oct 14 18:26:25 2013 +0200 @@ -151,6 +151,9 @@ def main(): """ Main entry point into the application. + + @exception Exception re-raised for any exception occurring in the main + program logic """ from Globals import AppInfo import Globals
--- a/install.py Sun Oct 13 17:44:48 2013 +0200 +++ b/install.py Mon Oct 14 18:26:25 2013 +0200 @@ -68,6 +68,8 @@ def exit(rcode=0): """ Exit the install script. + + @param rcode result code to report back (integer) """ global currDir
--- a/uninstall.py Sun Oct 13 17:44:48 2013 +0200 +++ b/uninstall.py Mon Oct 14 18:26:25 2013 +0200 @@ -29,6 +29,8 @@ def exit(rcode=0): """ Exit the uninstall script. + + @param rcode result code to report back (integer) """ # restore the local eric5config.py if os.path.exists("eric5config.py.orig"): @@ -41,7 +43,7 @@ """ Display a usage message and exit. - rcode is the return code passed back to the calling process. + @param rcode return code passed back to the calling process (integer) """ global progName @@ -65,6 +67,10 @@ def wrapperName(dname, wfile): """ Create the platform specific name for the wrapper script. + + @param dname name of the directory to place the wrapper into + @param wfile basename (without extension) of the wrapper script + @return the name of the wrapper script """ if sys.platform.startswith("win"): wname = dname + "\\" + wfile + ".bat" @@ -166,7 +172,7 @@ """ The main function of the script. - argv is the list of command line arguments. + @param argv list of command line arguments """ import getopt
