Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.DocumentationTools.QtHelpGenerator.html
Documentation/Source/eric5.DocumentationTools.QtHelpGenerator.html
- changeset 253
- 3ccdf551bde7
- parent 103
- 59137afca666
- child 409
- 0ea528e80202
equal
deleted
inserted
replaced
| 252:05692e3d37bf | 253:3ccdf551bde7 |
|---|---|
| 55 <table> | 55 <table> |
| 56 <tr> | 56 <tr> |
| 57 <td><a href="#QtHelpGenerator.__init__">QtHelpGenerator</a></td> | 57 <td><a href="#QtHelpGenerator.__init__">QtHelpGenerator</a></td> |
| 58 <td>Constructor</td> | 58 <td>Constructor</td> |
| 59 </tr><tr> | 59 </tr><tr> |
| 60 <td><a href="#QtHelpGenerator.__convertEol">__convertEol</a></td> | |
| 61 <td>Private method to convert the newline characters.</td> | |
| 62 </tr><tr> | |
| 60 <td><a href="#QtHelpGenerator.__generateSections">__generateSections</a></td> | 63 <td><a href="#QtHelpGenerator.__generateSections">__generateSections</a></td> |
| 61 <td>Private method to generate the sections part.</td> | 64 <td>Private method to generate the sections part.</td> |
| 62 </tr><tr> | 65 </tr><tr> |
| 63 <td><a href="#QtHelpGenerator.generateFiles">generateFiles</a></td> | 66 <td><a href="#QtHelpGenerator.generateFiles">generateFiles</a></td> |
| 64 <td>Public method to generate all index files.</td> | 67 <td>Public method to generate all index files.</td> |
| 97 </dd><dt><i>createCollection</i></dt> | 100 </dd><dt><i>createCollection</i></dt> |
| 98 <dd> | 101 <dd> |
| 99 flag indicating the generation of the collection | 102 flag indicating the generation of the collection |
| 100 files (boolean) | 103 files (boolean) |
| 101 </dd> | 104 </dd> |
| 105 </dl><a NAME="QtHelpGenerator.__convertEol" ID="QtHelpGenerator.__convertEol"></a> | |
| 106 <h4>QtHelpGenerator.__convertEol</h4> | |
| 107 <b>__convertEol</b>(<i>txt, newline</i>) | |
| 108 <p> | |
| 109 Private method to convert the newline characters. | |
| 110 </p><dl> | |
| 111 <dt><i>txt</i></dt> | |
| 112 <dd> | |
| 113 text to be converted (string) | |
| 114 </dd><dt><i>newline</i></dt> | |
| 115 <dd> | |
| 116 newline character to be used (string) | |
| 117 </dd> | |
| 118 </dl><dl> | |
| 119 <dt>Returns:</dt> | |
| 120 <dd> | |
| 121 converted text (string) | |
| 122 </dd> | |
| 102 </dl><a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a> | 123 </dl><a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a> |
| 103 <h4>QtHelpGenerator.__generateSections</h4> | 124 <h4>QtHelpGenerator.__generateSections</h4> |
| 104 <b>__generateSections</b>(<i>package, level</i>) | 125 <b>__generateSections</b>(<i>package, level</i>) |
| 105 <p> | 126 <p> |
| 106 Private method to generate the sections part. | 127 Private method to generate the sections part. |
| 117 <dd> | 138 <dd> |
| 118 sections part (string) | 139 sections part (string) |
| 119 </dd> | 140 </dd> |
| 120 </dl><a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a> | 141 </dl><a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a> |
| 121 <h4>QtHelpGenerator.generateFiles</h4> | 142 <h4>QtHelpGenerator.generateFiles</h4> |
| 122 <b>generateFiles</b>(<i>basename = ""</i>) | 143 <b>generateFiles</b>(<i>basename = "", newline = None</i>) |
| 123 <p> | 144 <p> |
| 124 Public method to generate all index files. | 145 Public method to generate all index files. |
| 125 </p><dl> | 146 </p><dl> |
| 126 <dt><i>basename</i></dt> | 147 <dt><i>basename</i></dt> |
| 127 <dd> | 148 <dd> |
| 128 The basename of the file hierarchy to be documented. | 149 The basename of the file hierarchy to be documented. |
| 129 The basename is stripped off the filename if it starts with | 150 The basename is stripped off the filename if it starts with |
| 130 the basename. | 151 the basename. |
| 152 </dd><dt><i>newline</i></dt> | |
| 153 <dd> | |
| 154 newline character to be used (string) | |
| 131 </dd> | 155 </dd> |
| 132 </dl><a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a> | 156 </dl><a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a> |
| 133 <h4>QtHelpGenerator.remember</h4> | 157 <h4>QtHelpGenerator.remember</h4> |
| 134 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) | 158 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) |
| 135 <p> | 159 <p> |
