Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.html
src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.html
- branch
- eric7
- changeset 10437
- 2f70ca07f0af
- parent 10316
- bae834dc40ec
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10436:f6881d10e995 | 10437:2f70ca07f0af |
|---|---|
| 104 <p> | 104 <p> |
| 105 Constructor | 105 Constructor |
| 106 </p> | 106 </p> |
| 107 <dl> | 107 <dl> |
| 108 | 108 |
| 109 <dt><i>cmdname</i></dt> | 109 <dt><i>cmdname</i> (str)</dt> |
| 110 <dd> | 110 <dd> |
| 111 name of the documentation generator (string) | 111 name of the documentation generator |
| 112 </dd> | 112 </dd> |
| 113 <dt><i>parent</i></dt> | 113 <dt><i>parent</i> (QWidget)</dt> |
| 114 <dd> | 114 <dd> |
| 115 parent widget of this dialog (QWidget) | 115 parent widget of this dialog |
| 116 </dd> | 116 </dd> |
| 117 </dl> | 117 </dl> |
| 118 <a NAME="EricdocExecDialog.__finish" ID="EricdocExecDialog.__finish"></a> | 118 <a NAME="EricdocExecDialog.__finish" ID="EricdocExecDialog.__finish"></a> |
| 119 <h4>EricdocExecDialog.__finish</h4> | 119 <h4>EricdocExecDialog.__finish</h4> |
| 120 <b>__finish</b>(<i></i>) | 120 <b>__finish</b>(<i></i>) |
| 155 <p> | 155 <p> |
| 156 Private slot called by a button of the button box clicked. | 156 Private slot called by a button of the button box clicked. |
| 157 </p> | 157 </p> |
| 158 <dl> | 158 <dl> |
| 159 | 159 |
| 160 <dt><i>button</i></dt> | 160 <dt><i>button</i> (QAbstractButton)</dt> |
| 161 <dd> | 161 <dd> |
| 162 button that was clicked (QAbstractButton) | 162 button that was clicked |
| 163 </dd> | 163 </dd> |
| 164 </dl> | 164 </dl> |
| 165 <a NAME="EricdocExecDialog.start" ID="EricdocExecDialog.start"></a> | 165 <a NAME="EricdocExecDialog.start" ID="EricdocExecDialog.start"></a> |
| 166 <h4>EricdocExecDialog.start</h4> | 166 <h4>EricdocExecDialog.start</h4> |
| 167 <b>start</b>(<i>args, fn</i>) | 167 <b>start</b>(<i>args, fn</i>) |
| 169 <p> | 169 <p> |
| 170 Public slot to start the ericdoc command. | 170 Public slot to start the ericdoc command. |
| 171 </p> | 171 </p> |
| 172 <dl> | 172 <dl> |
| 173 | 173 |
| 174 <dt><i>args</i></dt> | 174 <dt><i>args</i> (list of str)</dt> |
| 175 <dd> | 175 <dd> |
| 176 commandline arguments for ericdoc program (list of strings) | 176 commandline arguments for ericdoc program |
| 177 </dd> | 177 </dd> |
| 178 <dt><i>fn</i></dt> | 178 <dt><i>fn</i> (str)</dt> |
| 179 <dd> | 179 <dd> |
| 180 filename or dirname to be processed by ericdoc program | 180 filename or dirname to be processed by ericdoc program |
| 181 (string) | |
| 182 </dd> | 181 </dd> |
| 183 </dl> | 182 </dl> |
| 184 <dl> | 183 <dl> |
| 185 <dt>Return:</dt> | 184 <dt>Return:</dt> |
| 186 <dd> | 185 <dd> |
| 187 flag indicating the successful start of the process (boolean) | 186 flag indicating the successful start of the process |
| 187 </dd> | |
| 188 </dl> | |
| 189 <dl> | |
| 190 <dt>Return Type:</dt> | |
| 191 <dd> | |
| 192 bool | |
| 188 </dd> | 193 </dd> |
| 189 </dl> | 194 </dl> |
| 190 <div align="right"><a href="#top">Up</a></div> | 195 <div align="right"><a href="#top">Up</a></div> |
| 191 <hr /> | 196 <hr /> |
| 192 </body></html> | 197 </body></html> |
