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 10423
- 299802979277
- parent 9236
- db53a9efe7ef
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10422:e28b89693f37 | 10423:299802979277 |
|---|---|
| 90 <p> | 90 <p> |
| 91 Constructor | 91 Constructor |
| 92 </p> | 92 </p> |
| 93 <dl> | 93 <dl> |
| 94 | 94 |
| 95 <dt><i>htmlDir</i></dt> | 95 <dt><i>htmlDir</i> (str)</dt> |
| 96 <dd> | 96 <dd> |
| 97 directory containing the HTML files (string) | 97 directory containing the HTML files |
| 98 </dd> | 98 </dd> |
| 99 <dt><i>outputDir</i></dt> | 99 <dt><i>outputDir</i> (str)</dt> |
| 100 <dd> | 100 <dd> |
| 101 output directory for the files (string) | 101 output directory for the files |
| 102 </dd> | 102 </dd> |
| 103 <dt><i>namespace</i></dt> | 103 <dt><i>namespace</i> (str)</dt> |
| 104 <dd> | 104 <dd> |
| 105 namespace to be used (string) | 105 namespace to be used |
| 106 </dd> | 106 </dd> |
| 107 <dt><i>virtualFolder</i></dt> | 107 <dt><i>virtualFolder</i> (str)</dt> |
| 108 <dd> | 108 <dd> |
| 109 virtual folder to be used (string) | 109 virtual folder to be used |
| 110 </dd> | 110 </dd> |
| 111 <dt><i>filterName</i></dt> | 111 <dt><i>filterName</i> (str)</dt> |
| 112 <dd> | 112 <dd> |
| 113 name of the custom filter (string) | 113 name of the custom filter |
| 114 </dd> | 114 </dd> |
| 115 <dt><i>filterAttributes</i></dt> | 115 <dt><i>filterAttributes</i> (str)</dt> |
| 116 <dd> | 116 <dd> |
| 117 ':' separated list of filter attributes | 117 ':' separated list of filter attributes |
| 118 (string) | 118 </dd> |
| 119 </dd> | 119 <dt><i>title</i> (str)</dt> |
| 120 <dt><i>title</i></dt> | 120 <dd> |
| 121 <dd> | 121 title to be used for the generated help |
| 122 title to be used for the generated help (string) | 122 </dd> |
| 123 </dd> | 123 <dt><i>createCollection</i> (bool)</dt> |
| 124 <dt><i>createCollection</i></dt> | |
| 125 <dd> | 124 <dd> |
| 126 flag indicating the generation of the | 125 flag indicating the generation of the |
| 127 collection files (boolean) | 126 collection files |
| 128 </dd> | 127 </dd> |
| 129 </dl> | 128 </dl> |
| 130 <a NAME="QtHelpGenerator.__convertEol" ID="QtHelpGenerator.__convertEol"></a> | 129 <a NAME="QtHelpGenerator.__convertEol" ID="QtHelpGenerator.__convertEol"></a> |
| 131 <h4>QtHelpGenerator.__convertEol</h4> | 130 <h4>QtHelpGenerator.__convertEol</h4> |
| 132 <b>__convertEol</b>(<i>txt, newline</i>) | 131 <b>__convertEol</b>(<i>txt, newline</i>) |
| 134 <p> | 133 <p> |
| 135 Private method to convert the newline characters. | 134 Private method to convert the newline characters. |
| 136 </p> | 135 </p> |
| 137 <dl> | 136 <dl> |
| 138 | 137 |
| 139 <dt><i>txt</i></dt> | 138 <dt><i>txt</i> (str)</dt> |
| 140 <dd> | 139 <dd> |
| 141 text to be converted (string) | 140 text to be converted |
| 142 </dd> | 141 </dd> |
| 143 <dt><i>newline</i></dt> | 142 <dt><i>newline</i> (str)</dt> |
| 144 <dd> | 143 <dd> |
| 145 newline character to be used (string) | 144 newline character to be used |
| 146 </dd> | 145 </dd> |
| 147 </dl> | 146 </dl> |
| 148 <dl> | 147 <dl> |
| 149 <dt>Return:</dt> | 148 <dt>Return:</dt> |
| 150 <dd> | 149 <dd> |
| 151 converted text (string) | 150 converted text |
| 151 </dd> | |
| 152 </dl> | |
| 153 <dl> | |
| 154 <dt>Return Type:</dt> | |
| 155 <dd> | |
| 156 str | |
| 152 </dd> | 157 </dd> |
| 153 </dl> | 158 </dl> |
| 154 <a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a> | 159 <a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a> |
| 155 <h4>QtHelpGenerator.__generateSections</h4> | 160 <h4>QtHelpGenerator.__generateSections</h4> |
| 156 <b>__generateSections</b>(<i>package, level</i>) | 161 <b>__generateSections</b>(<i>package, level</i>) |
| 158 <p> | 163 <p> |
| 159 Private method to generate the sections part. | 164 Private method to generate the sections part. |
| 160 </p> | 165 </p> |
| 161 <dl> | 166 <dl> |
| 162 | 167 |
| 163 <dt><i>package</i></dt> | 168 <dt><i>package</i> (str)</dt> |
| 164 <dd> | 169 <dd> |
| 165 name of the package to process (string) | 170 name of the package to process |
| 166 </dd> | 171 </dd> |
| 167 <dt><i>level</i></dt> | 172 <dt><i>level</i> (int)</dt> |
| 168 <dd> | 173 <dd> |
| 169 indentation level (integer) | 174 indentation level |
| 170 </dd> | 175 </dd> |
| 171 </dl> | 176 </dl> |
| 172 <dl> | 177 <dl> |
| 173 <dt>Return:</dt> | 178 <dt>Return:</dt> |
| 174 <dd> | 179 <dd> |
| 175 sections part (string) | 180 sections part |
| 181 </dd> | |
| 182 </dl> | |
| 183 <dl> | |
| 184 <dt>Return Type:</dt> | |
| 185 <dd> | |
| 186 str | |
| 176 </dd> | 187 </dd> |
| 177 </dl> | 188 </dl> |
| 178 <a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a> | 189 <a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a> |
| 179 <h4>QtHelpGenerator.generateFiles</h4> | 190 <h4>QtHelpGenerator.generateFiles</h4> |
| 180 <b>generateFiles</b>(<i>basename="", newline=None</i>) | 191 <b>generateFiles</b>(<i>basename="", newline=None</i>) |
| 182 <p> | 193 <p> |
| 183 Public method to generate all index files. | 194 Public method to generate all index files. |
| 184 </p> | 195 </p> |
| 185 <dl> | 196 <dl> |
| 186 | 197 |
| 187 <dt><i>basename</i></dt> | 198 <dt><i>basename</i> (str)</dt> |
| 188 <dd> | 199 <dd> |
| 189 The basename of the file hierarchy to be documented. | 200 base name of the file hierarchy to be documented. |
| 190 The basename is stripped off the filename if it starts with | 201 The base name is stripped off the filename if it starts with |
| 191 the basename. | 202 the base name. |
| 192 </dd> | 203 </dd> |
| 193 <dt><i>newline</i></dt> | 204 <dt><i>newline</i> (str)</dt> |
| 194 <dd> | 205 <dd> |
| 195 newline character to be used (string) | 206 newline character to be used |
| 196 </dd> | 207 </dd> |
| 197 </dl> | 208 </dl> |
| 198 <a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a> | 209 <a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a> |
| 199 <h4>QtHelpGenerator.remember</h4> | 210 <h4>QtHelpGenerator.remember</h4> |
| 200 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) | 211 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) |
| 202 <p> | 213 <p> |
| 203 Public method to remember a documentation file. | 214 Public method to remember a documentation file. |
| 204 </p> | 215 </p> |
| 205 <dl> | 216 <dl> |
| 206 | 217 |
| 207 <dt><i>file</i></dt> | 218 <dt><i>file</i> (str)</dt> |
| 208 <dd> | 219 <dd> |
| 209 The filename to be remembered. (string) | 220 The filename to be remembered. |
| 210 </dd> | 221 </dd> |
| 211 <dt><i>moduleDocument</i></dt> | 222 <dt><i>moduleDocument</i> (ModuleDocument)</dt> |
| 212 <dd> | 223 <dd> |
| 213 The ModuleDocument object containing the | 224 module documentation object containing the |
| 214 information for the file. | 225 information for the file. |
| 215 </dd> | 226 </dd> |
| 216 <dt><i>basename</i></dt> | 227 <dt><i>basename</i> (str)</dt> |
| 217 <dd> | 228 <dd> |
| 218 The basename of the file hierarchy to be documented. | 229 base name of the file hierarchy to be documented. |
| 219 The basename is stripped off the filename if it starts with | 230 The base name is stripped off the filename if it starts with |
| 220 the basename. | 231 the base name. |
| 221 </dd> | 232 </dd> |
| 222 </dl> | 233 </dl> |
| 223 <div align="right"><a href="#top">Up</a></div> | 234 <div align="right"><a href="#top">Up</a></div> |
| 224 <hr /> | 235 <hr /> |
| 225 </body></html> | 236 </body></html> |
