Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.DocumentationTools.QtHelpGenerator.html
src/eric7/Documentation/Source/eric7.DocumentationTools.QtHelpGenerator.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10423
- 299802979277
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.DocumentationTools.QtHelpGenerator</h1> | 9 <h1>eric7.DocumentationTools.QtHelpGenerator</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the QtHelp generator for the builtin documentation | 11 Module implementing the QtHelp generator for the builtin documentation |
| 13 generator. | 12 generator. |
| 14 </p> | 13 </p> |
| 14 | |
| 15 <h3>Global Attributes</h3> | 15 <h3>Global Attributes</h3> |
| 16 | 16 <table> |
| 17 <table> | 17 <tr><td>HelpCollection</td></tr> |
| 18 <tr><td>HelpCollection</td></tr><tr><td>HelpCollectionFile</td></tr><tr><td>HelpCollectionProjectFile</td></tr><tr><td>HelpHelpFile</td></tr><tr><td>HelpProject</td></tr><tr><td>HelpProjectFile</td></tr> | 18 <tr><td>HelpCollectionFile</td></tr> |
| 19 </table> | 19 <tr><td>HelpCollectionProjectFile</td></tr> |
| 20 <tr><td>HelpHelpFile</td></tr> | |
| 21 <tr><td>HelpProject</td></tr> | |
| 22 <tr><td>HelpProjectFile</td></tr> | |
| 23 </table> | |
| 24 | |
| 20 <h3>Classes</h3> | 25 <h3>Classes</h3> |
| 21 | 26 <table> |
| 22 <table> | |
| 23 | |
| 24 <tr> | 27 <tr> |
| 25 <td><a href="#QtHelpGenerator">QtHelpGenerator</a></td> | 28 <td><a href="#QtHelpGenerator">QtHelpGenerator</a></td> |
| 26 <td>Class implementing the QtHelp generator for the builtin documentation generator.</td> | 29 <td>Class implementing the QtHelp generator for the builtin documentation generator.</td> |
| 27 </tr> | 30 </tr> |
| 28 </table> | 31 </table> |
| 32 | |
| 29 <h3>Functions</h3> | 33 <h3>Functions</h3> |
| 30 | 34 <table> |
| 31 <table> | 35 <tr><td>None</td></tr> |
| 32 <tr><td>None</td></tr> | 36 </table> |
| 33 </table> | 37 |
| 34 <hr /> | 38 <hr /> |
| 35 <hr /> | 39 <hr /> |
| 36 <a NAME="QtHelpGenerator" ID="QtHelpGenerator"></a> | 40 <a NAME="QtHelpGenerator" ID="QtHelpGenerator"></a> |
| 37 <h2>QtHelpGenerator</h2> | 41 <h2>QtHelpGenerator</h2> |
| 38 | |
| 39 <p> | 42 <p> |
| 40 Class implementing the QtHelp generator for the builtin documentation | 43 Class implementing the QtHelp generator for the builtin documentation |
| 41 generator. | 44 generator. |
| 42 </p> | 45 </p> |
| 46 | |
| 43 <h3>Derived from</h3> | 47 <h3>Derived from</h3> |
| 44 None | 48 None |
| 45 <h3>Class Attributes</h3> | 49 <h3>Class Attributes</h3> |
| 46 | 50 <table> |
| 47 <table> | 51 <tr><td>None</td></tr> |
| 48 <tr><td>None</td></tr> | 52 </table> |
| 49 </table> | 53 |
| 50 <h3>Class Methods</h3> | 54 <h3>Class Methods</h3> |
| 51 | 55 <table> |
| 52 <table> | 56 <tr><td>None</td></tr> |
| 53 <tr><td>None</td></tr> | 57 </table> |
| 54 </table> | 58 |
| 55 <h3>Methods</h3> | 59 <h3>Methods</h3> |
| 56 | 60 <table> |
| 57 <table> | |
| 58 | |
| 59 <tr> | 61 <tr> |
| 60 <td><a href="#QtHelpGenerator.__init__">QtHelpGenerator</a></td> | 62 <td><a href="#QtHelpGenerator.__init__">QtHelpGenerator</a></td> |
| 61 <td>Constructor</td> | 63 <td>Constructor</td> |
| 62 </tr> | 64 </tr> |
| 63 <tr> | 65 <tr> |
| 75 <tr> | 77 <tr> |
| 76 <td><a href="#QtHelpGenerator.remember">remember</a></td> | 78 <td><a href="#QtHelpGenerator.remember">remember</a></td> |
| 77 <td>Public method to remember a documentation file.</td> | 79 <td>Public method to remember a documentation file.</td> |
| 78 </tr> | 80 </tr> |
| 79 </table> | 81 </table> |
| 82 | |
| 80 <h3>Static Methods</h3> | 83 <h3>Static Methods</h3> |
| 81 | 84 <table> |
| 82 <table> | 85 <tr><td>None</td></tr> |
| 83 <tr><td>None</td></tr> | 86 </table> |
| 84 </table> | 87 |
| 85 | 88 |
| 86 <a NAME="QtHelpGenerator.__init__" ID="QtHelpGenerator.__init__"></a> | 89 <a NAME="QtHelpGenerator.__init__" ID="QtHelpGenerator.__init__"></a> |
| 87 <h4>QtHelpGenerator (Constructor)</h4> | 90 <h4>QtHelpGenerator (Constructor)</h4> |
| 88 <b>QtHelpGenerator</b>(<i>htmlDir, outputDir, namespace, virtualFolder, filterName, filterAttributes, title, createCollection, </i>) | 91 <b>QtHelpGenerator</b>(<i>htmlDir, outputDir, namespace, virtualFolder, filterName, filterAttributes, title, createCollection, </i>) |
| 89 | |
| 90 <p> | 92 <p> |
| 91 Constructor | 93 Constructor |
| 92 </p> | 94 </p> |
| 95 | |
| 93 <dl> | 96 <dl> |
| 94 | 97 |
| 95 <dt><i>htmlDir</i> (str)</dt> | 98 <dt><i>htmlDir</i> (str)</dt> |
| 96 <dd> | 99 <dd> |
| 97 directory containing the HTML files | 100 directory containing the HTML files |
| 127 </dd> | 130 </dd> |
| 128 </dl> | 131 </dl> |
| 129 <a NAME="QtHelpGenerator.__convertEol" ID="QtHelpGenerator.__convertEol"></a> | 132 <a NAME="QtHelpGenerator.__convertEol" ID="QtHelpGenerator.__convertEol"></a> |
| 130 <h4>QtHelpGenerator.__convertEol</h4> | 133 <h4>QtHelpGenerator.__convertEol</h4> |
| 131 <b>__convertEol</b>(<i>txt, newline</i>) | 134 <b>__convertEol</b>(<i>txt, newline</i>) |
| 132 | |
| 133 <p> | 135 <p> |
| 134 Private method to convert the newline characters. | 136 Private method to convert the newline characters. |
| 135 </p> | 137 </p> |
| 138 | |
| 136 <dl> | 139 <dl> |
| 137 | 140 |
| 138 <dt><i>txt</i> (str)</dt> | 141 <dt><i>txt</i> (str)</dt> |
| 139 <dd> | 142 <dd> |
| 140 text to be converted | 143 text to be converted |
| 157 </dd> | 160 </dd> |
| 158 </dl> | 161 </dl> |
| 159 <a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a> | 162 <a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a> |
| 160 <h4>QtHelpGenerator.__generateSections</h4> | 163 <h4>QtHelpGenerator.__generateSections</h4> |
| 161 <b>__generateSections</b>(<i>package, level</i>) | 164 <b>__generateSections</b>(<i>package, level</i>) |
| 162 | |
| 163 <p> | 165 <p> |
| 164 Private method to generate the sections part. | 166 Private method to generate the sections part. |
| 165 </p> | 167 </p> |
| 168 | |
| 166 <dl> | 169 <dl> |
| 167 | 170 |
| 168 <dt><i>package</i> (str)</dt> | 171 <dt><i>package</i> (str)</dt> |
| 169 <dd> | 172 <dd> |
| 170 name of the package to process | 173 name of the package to process |
| 187 </dd> | 190 </dd> |
| 188 </dl> | 191 </dl> |
| 189 <a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a> | 192 <a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a> |
| 190 <h4>QtHelpGenerator.generateFiles</h4> | 193 <h4>QtHelpGenerator.generateFiles</h4> |
| 191 <b>generateFiles</b>(<i>basename="", newline=None</i>) | 194 <b>generateFiles</b>(<i>basename="", newline=None</i>) |
| 192 | |
| 193 <p> | 195 <p> |
| 194 Public method to generate all index files. | 196 Public method to generate all index files. |
| 195 </p> | 197 </p> |
| 198 | |
| 196 <dl> | 199 <dl> |
| 197 | 200 |
| 198 <dt><i>basename</i> (str)</dt> | 201 <dt><i>basename</i> (str)</dt> |
| 199 <dd> | 202 <dd> |
| 200 base name of the file hierarchy to be documented. | 203 base name of the file hierarchy to be documented. |
| 207 </dd> | 210 </dd> |
| 208 </dl> | 211 </dl> |
| 209 <a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a> | 212 <a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a> |
| 210 <h4>QtHelpGenerator.remember</h4> | 213 <h4>QtHelpGenerator.remember</h4> |
| 211 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) | 214 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) |
| 212 | |
| 213 <p> | 215 <p> |
| 214 Public method to remember a documentation file. | 216 Public method to remember a documentation file. |
| 215 </p> | 217 </p> |
| 218 | |
| 216 <dl> | 219 <dl> |
| 217 | 220 |
| 218 <dt><i>file</i> (str)</dt> | 221 <dt><i>file</i> (str)</dt> |
| 219 <dd> | 222 <dd> |
| 220 The filename to be remembered. | 223 The filename to be remembered. |
