Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.DocumentationTools.QtHelpGenerator.html
Documentation/Source/eric5.DocumentationTools.QtHelpGenerator.html
- changeset 58
- 37f0444c3479
- parent 21
- b88a0e6268bd
- child 103
- 59137afca666
equal
deleted
inserted
replaced
| 57:81326a94fdca | 58:37f0444c3479 |
|---|---|
| 20 </style> | 20 </style> |
| 21 </head> | 21 </head> |
| 22 <body><a NAME="top" ID="top"></a> | 22 <body><a NAME="top" ID="top"></a> |
| 23 <h1>eric5.DocumentationTools.QtHelpGenerator</h1> | 23 <h1>eric5.DocumentationTools.QtHelpGenerator</h1> |
| 24 <p> | 24 <p> |
| 25 Module implementing the QtHelp generator for the builtin documentation generator. | 25 Module implementing the QtHelp generator for the builtin documentation generator. |
| 26 </p> | 26 </p> |
| 27 <h3>Global Attributes</h3> | 27 <h3>Global Attributes</h3> |
| 28 <table> | 28 <table> |
| 29 <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> | 29 <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> |
| 30 </table> | 30 </table> |
| 31 <h3>Classes</h3> | 31 <h3>Classes</h3> |
| 32 <table> | 32 <table> |
| 33 <tr> | 33 <tr> |
| 34 <td><a href="#QtHelpGenerator">QtHelpGenerator</a></td> | 34 <td><a href="#QtHelpGenerator">QtHelpGenerator</a></td> |
| 35 <td>Class implementing the QtHelp generator for the builtin documentation generator.</td> | 35 <td>Class implementing the QtHelp generator for the builtin documentation generator.</td> |
| 36 </tr> | 36 </tr> |
| 37 </table> | 37 </table> |
| 38 <h3>Functions</h3> | 38 <h3>Functions</h3> |
| 39 <table> | 39 <table> |
| 40 <tr><td>None</td></tr> | 40 <tr><td>None</td></tr> |
| 41 </table> | 41 </table> |
| 42 <hr /><hr /> | 42 <hr /><hr /> |
| 43 <a NAME="QtHelpGenerator" ID="QtHelpGenerator"></a> | 43 <a NAME="QtHelpGenerator" ID="QtHelpGenerator"></a> |
| 44 <h2>QtHelpGenerator</h2> | 44 <h2>QtHelpGenerator</h2> |
| 45 <p> | 45 <p> |
| 46 Class implementing the QtHelp generator for the builtin documentation generator. | 46 Class implementing the QtHelp generator for the builtin documentation generator. |
| 47 </p> | 47 </p> |
| 48 <h3>Derived from</h3> | 48 <h3>Derived from</h3> |
| 49 object | 49 object |
| 50 <h3>Class Attributes</h3> | 50 <h3>Class Attributes</h3> |
| 51 <table> | 51 <table> |
| 53 </table> | 53 </table> |
| 54 <h3>Methods</h3> | 54 <h3>Methods</h3> |
| 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.__generateKeywords">__generateKeywords</a></td> | 60 <td><a href="#QtHelpGenerator.__generateKeywords">__generateKeywords</a></td> |
| 61 <td>Private method to generate the keywords section.</td> | 61 <td>Private method to generate the keywords section.</td> |
| 62 </tr><tr> | 62 </tr><tr> |
| 63 <td><a href="#QtHelpGenerator.__generateSections">__generateSections</a></td> | 63 <td><a href="#QtHelpGenerator.__generateSections">__generateSections</a></td> |
| 64 <td>Private method to generate the sections part.</td> | 64 <td>Private method to generate the sections part.</td> |
| 65 </tr><tr> | 65 </tr><tr> |
| 66 <td><a href="#QtHelpGenerator.generateFiles">generateFiles</a></td> | 66 <td><a href="#QtHelpGenerator.generateFiles">generateFiles</a></td> |
| 67 <td>Public method to generate all index files.</td> | 67 <td>Public method to generate all index files.</td> |
| 68 </tr><tr> | 68 </tr><tr> |
| 69 <td><a href="#QtHelpGenerator.remember">remember</a></td> | 69 <td><a href="#QtHelpGenerator.remember">remember</a></td> |
| 70 <td>Public method to remember a documentation file.</td> | 70 <td>Public method to remember a documentation file.</td> |
| 71 </tr> | 71 </tr> |
| 72 </table> | 72 </table> |
| 73 <a NAME="QtHelpGenerator.__init__" ID="QtHelpGenerator.__init__"></a> | 73 <a NAME="QtHelpGenerator.__init__" ID="QtHelpGenerator.__init__"></a> |
| 74 <h4>QtHelpGenerator (Constructor)</h4> | 74 <h4>QtHelpGenerator (Constructor)</h4> |
| 75 <b>QtHelpGenerator</b>(<i>htmlDir, outputDir, namespace, virtualFolder, filterName, filterAttributes, title, createCollection</i>) | 75 <b>QtHelpGenerator</b>(<i>htmlDir, outputDir, namespace, virtualFolder, filterName, filterAttributes, title, createCollection</i>) |
| 76 <p> | 76 <p> |
| 77 Constructor | 77 Constructor |
| 78 </p><dl> | 78 </p><dl> |
| 79 <dt><i>htmlDir</i></dt> | 79 <dt><i>htmlDir</i></dt> |
| 80 <dd> | 80 <dd> |
| 81 directory containing the HTML files (string) | 81 directory containing the HTML files (string) |
| 82 </dd><dt><i>outputDir</i></dt> | 82 </dd><dt><i>outputDir</i></dt> |
| 83 <dd> | 83 <dd> |
| 84 output directory for the files (string) | 84 output directory for the files (string) |
| 85 </dd><dt><i>namespace</i></dt> | 85 </dd><dt><i>namespace</i></dt> |
| 86 <dd> | 86 <dd> |
| 87 namespace to be used (string) | 87 namespace to be used (string) |
| 88 </dd><dt><i>virtualFolder</i></dt> | 88 </dd><dt><i>virtualFolder</i></dt> |
| 89 <dd> | 89 <dd> |
| 90 virtual folder to be used (string) | 90 virtual folder to be used (string) |
| 91 </dd><dt><i>filterName</i></dt> | 91 </dd><dt><i>filterName</i></dt> |
| 92 <dd> | 92 <dd> |
| 93 name of the custom filter (string) | 93 name of the custom filter (string) |
| 94 </dd><dt><i>filterAttributes</i></dt> | 94 </dd><dt><i>filterAttributes</i></dt> |
| 95 <dd> | 95 <dd> |
| 96 ':' separated list of filter attributes (string) | 96 ':' separated list of filter attributes (string) |
| 97 </dd><dt><i>title</i></dt> | 97 </dd><dt><i>title</i></dt> |
| 98 <dd> | 98 <dd> |
| 99 title to be used for the generated help (string) | 99 title to be used for the generated help (string) |
| 100 </dd><dt><i>createCollection</i></dt> | 100 </dd><dt><i>createCollection</i></dt> |
| 101 <dd> | 101 <dd> |
| 102 flag indicating the generation of the collection | 102 flag indicating the generation of the collection |
| 103 files (boolean) | 103 files (boolean) |
| 104 </dd> | 104 </dd> |
| 105 </dl><a NAME="QtHelpGenerator.__generateKeywords" ID="QtHelpGenerator.__generateKeywords"></a> | 105 </dl><a NAME="QtHelpGenerator.__generateKeywords" ID="QtHelpGenerator.__generateKeywords"></a> |
| 106 <h4>QtHelpGenerator.__generateKeywords</h4> | 106 <h4>QtHelpGenerator.__generateKeywords</h4> |
| 107 <b>__generateKeywords</b>(<i></i>) | 107 <b>__generateKeywords</b>(<i></i>) |
| 108 <p> | 108 <p> |
| 109 Private method to generate the keywords section. | 109 Private method to generate the keywords section. |
| 110 </p><dl> | 110 </p><dl> |
| 111 <dt>Returns:</dt> | 111 <dt>Returns:</dt> |
| 112 <dd> | 112 <dd> |
| 113 keywords section (string) | 113 keywords section (string) |
| 114 </dd> | 114 </dd> |
| 115 </dl><a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a> | 115 </dl><a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a> |
| 116 <h4>QtHelpGenerator.__generateSections</h4> | 116 <h4>QtHelpGenerator.__generateSections</h4> |
| 117 <b>__generateSections</b>(<i>package, level</i>) | 117 <b>__generateSections</b>(<i>package, level</i>) |
| 118 <p> | 118 <p> |
| 119 Private method to generate the sections part. | 119 Private method to generate the sections part. |
| 120 </p><dl> | 120 </p><dl> |
| 121 <dt><i>package</i></dt> | 121 <dt><i>package</i></dt> |
| 122 <dd> | 122 <dd> |
| 123 name of the package to process (string) | 123 name of the package to process (string) |
| 124 </dd><dt><i>level</i></dt> | 124 </dd><dt><i>level</i></dt> |
| 125 <dd> | 125 <dd> |
| 126 indentation level (integer) | 126 indentation level (integer) |
| 127 </dd> | 127 </dd> |
| 128 </dl><dl> | 128 </dl><dl> |
| 129 <dt>Returns:</dt> | 129 <dt>Returns:</dt> |
| 130 <dd> | 130 <dd> |
| 131 sections part (string) | 131 sections part (string) |
| 132 </dd> | 132 </dd> |
| 133 </dl><a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a> | 133 </dl><a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a> |
| 134 <h4>QtHelpGenerator.generateFiles</h4> | 134 <h4>QtHelpGenerator.generateFiles</h4> |
| 135 <b>generateFiles</b>(<i>basename = ""</i>) | 135 <b>generateFiles</b>(<i>basename = ""</i>) |
| 136 <p> | 136 <p> |
| 137 Public method to generate all index files. | 137 Public method to generate all index files. |
| 138 </p><dl> | 138 </p><dl> |
| 139 <dt><i>basename</i></dt> | 139 <dt><i>basename</i></dt> |
| 140 <dd> | 140 <dd> |
| 141 The basename of the file hierarchy to be documented. | 141 The basename of the file hierarchy to be documented. |
| 142 The basename is stripped off the filename if it starts with | 142 The basename is stripped off the filename if it starts with |
| 143 the basename. | 143 the basename. |
| 144 </dd> | 144 </dd> |
| 145 </dl><a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a> | 145 </dl><a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a> |
| 146 <h4>QtHelpGenerator.remember</h4> | 146 <h4>QtHelpGenerator.remember</h4> |
| 147 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) | 147 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) |
| 148 <p> | 148 <p> |
| 149 Public method to remember a documentation file. | 149 Public method to remember a documentation file. |
| 150 </p><dl> | 150 </p><dl> |
| 151 <dt><i>file</i></dt> | 151 <dt><i>file</i></dt> |
| 152 <dd> | 152 <dd> |
| 153 The filename to be remembered. (string) | 153 The filename to be remembered. (string) |
| 154 </dd><dt><i>moduleDocument</i></dt> | 154 </dd><dt><i>moduleDocument</i></dt> |
| 155 <dd> | 155 <dd> |
| 156 The ModuleDocument object containing the | 156 The ModuleDocument object containing the |
| 157 information for the file. | 157 information for the file. |
| 158 </dd><dt><i>basename</i></dt> | 158 </dd><dt><i>basename</i></dt> |
| 159 <dd> | 159 <dd> |
| 160 The basename of the file hierarchy to be documented. | 160 The basename of the file hierarchy to be documented. |
| 161 The basename is stripped off the filename if it starts with | 161 The basename is stripped off the filename if it starts with |
| 162 the basename. | 162 the basename. |
| 163 </dd> | 163 </dd> |
| 164 </dl> | 164 </dl> |
| 165 <div align="right"><a href="#top">Up</a></div> | 165 <div align="right"><a href="#top">Up</a></div> |
| 166 <hr /> | 166 <hr /> |
| 167 </body></html> | 167 </body></html> |
