diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitSubmodulesSummaryOptionsDialog.html --- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitSubmodulesSummaryOptionsDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitSubmodulesSummaryOptionsDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,75 +18,97 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsGit.GitSubmodulesSummaryOptionsDialog</h1> + <p> Module implementing a dialog to enter submodule summary options. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#GitSubmodulesSummaryOptionsDialog">GitSubmodulesSummaryOptionsDialog</a></td> <td>Class implementing a dialog to enter submodule summary options.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="GitSubmodulesSummaryOptionsDialog" ID="GitSubmodulesSummaryOptionsDialog"></a> <h2>GitSubmodulesSummaryOptionsDialog</h2> + <p> Class implementing a dialog to enter submodule summary options. </p> <h3>Derived from</h3> QDialog, Ui_GitSubmodulesSummaryOptionsDialog <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#GitSubmodulesSummaryOptionsDialog.__init__">GitSubmodulesSummaryOptionsDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitSubmodulesSummaryOptionsDialog.getData">getData</a></td> <td>Public method to get the entered data.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="GitSubmodulesSummaryOptionsDialog.__init__" ID="GitSubmodulesSummaryOptionsDialog.__init__"></a> <h4>GitSubmodulesSummaryOptionsDialog (Constructor)</h4> <b>GitSubmodulesSummaryOptionsDialog</b>(<i>submodulePaths, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>submodulePaths</i> (list of str)</dt> <dd> list of submodule paths -</dd><dt><i>parent</i> (QWidget)</dt> +</dd> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> -</dl><a NAME="GitSubmodulesSummaryOptionsDialog.getData" ID="GitSubmodulesSummaryOptionsDialog.getData"></a> +</dl> +<a NAME="GitSubmodulesSummaryOptionsDialog.getData" ID="GitSubmodulesSummaryOptionsDialog.getData"></a> <h4>GitSubmodulesSummaryOptionsDialog.getData</h4> <b>getData</b>(<i></i>) + <p> Public method to get the entered data. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple containing a list of selected submodules, a flag @@ -94,7 +116,8 @@ indicating to show summary for the submodules index, an optional commit ID and a value for the number of entries to be shown </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> tuple of (list of str, bool, bool, str, int)