Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.DocumentationTools.QtHelpGenerator.html
Documentation/Source/eric5.DocumentationTools.QtHelpGenerator.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.DocumentationTools.QtHelpGenerator</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.DocumentationTools.QtHelpGenerator</h1> | |
| 12 <p> | |
| 13 Module implementing the QtHelp generator for the builtin documentation generator. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <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 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#QtHelpGenerator">QtHelpGenerator</a></td> | |
| 23 <td>Class implementing the QtHelp generator for the builtin documentation generator.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="QtHelpGenerator" ID="QtHelpGenerator"></a> | |
| 32 <h2>QtHelpGenerator</h2> | |
| 33 <p> | |
| 34 Class implementing the QtHelp generator for the builtin documentation generator. | |
| 35 </p> | |
| 36 <h3>Derived from</h3> | |
| 37 object | |
| 38 <h3>Class Attributes</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <h3>Methods</h3> | |
| 43 <table> | |
| 44 <tr> | |
| 45 <td><a href="#QtHelpGenerator.__init__">QtHelpGenerator</a></td> | |
| 46 <td>Constructor</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#QtHelpGenerator.__generateKeywords">__generateKeywords</a></td> | |
| 49 <td>Private method to generate the keywords section.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#QtHelpGenerator.__generateSections">__generateSections</a></td> | |
| 52 <td>Private method to generate the sections part.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#QtHelpGenerator.generateFiles">generateFiles</a></td> | |
| 55 <td>Public method to generate all index files.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#QtHelpGenerator.remember">remember</a></td> | |
| 58 <td>Public method to remember a documentation file.</td> | |
| 59 </tr> | |
| 60 </table> | |
| 61 <a NAME="QtHelpGenerator.__init__" ID="QtHelpGenerator.__init__"></a> | |
| 62 <h4>QtHelpGenerator (Constructor)</h4> | |
| 63 <b>QtHelpGenerator</b>(<i>htmlDir, outputDir, namespace, virtualFolder, filterName, filterAttributes, title, createCollection</i>) | |
| 64 <p> | |
| 65 Constructor | |
| 66 </p><dl> | |
| 67 <dt><i>htmlDir</i></dt> | |
| 68 <dd> | |
| 69 directory containing the HTML files (string) | |
| 70 </dd><dt><i>outputDir</i></dt> | |
| 71 <dd> | |
| 72 output directory for the files (string) | |
| 73 </dd><dt><i>namespace</i></dt> | |
| 74 <dd> | |
| 75 namespace to be used (string) | |
| 76 </dd><dt><i>virtualFolder</i></dt> | |
| 77 <dd> | |
| 78 virtual folder to be used (string) | |
| 79 </dd><dt><i>filterName</i></dt> | |
| 80 <dd> | |
| 81 name of the custom filter (string) | |
| 82 </dd><dt><i>filterAttributes</i></dt> | |
| 83 <dd> | |
| 84 ':' separated list of filter attributes (string) | |
| 85 </dd><dt><i>title</i></dt> | |
| 86 <dd> | |
| 87 title to be used for the generated help (string) | |
| 88 </dd><dt><i>createCollection</i></dt> | |
| 89 <dd> | |
| 90 flag indicating the generation of the collection | |
| 91 files (boolean) | |
| 92 </dd> | |
| 93 </dl><a NAME="QtHelpGenerator.__generateKeywords" ID="QtHelpGenerator.__generateKeywords"></a> | |
| 94 <h4>QtHelpGenerator.__generateKeywords</h4> | |
| 95 <b>__generateKeywords</b>(<i></i>) | |
| 96 <p> | |
| 97 Private method to generate the keywords section. | |
| 98 </p><dl> | |
| 99 <dt>Returns:</dt> | |
| 100 <dd> | |
| 101 keywords section (string) | |
| 102 </dd> | |
| 103 </dl><a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a> | |
| 104 <h4>QtHelpGenerator.__generateSections</h4> | |
| 105 <b>__generateSections</b>(<i>package, level</i>) | |
| 106 <p> | |
| 107 Private method to generate the sections part. | |
| 108 </p><dl> | |
| 109 <dt><i>package</i></dt> | |
| 110 <dd> | |
| 111 name of the package to process (string) | |
| 112 </dd><dt><i>level</i></dt> | |
| 113 <dd> | |
| 114 indentation level (integer) | |
| 115 </dd> | |
| 116 </dl><dl> | |
| 117 <dt>Returns:</dt> | |
| 118 <dd> | |
| 119 sections part (string) | |
| 120 </dd> | |
| 121 </dl><a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a> | |
| 122 <h4>QtHelpGenerator.generateFiles</h4> | |
| 123 <b>generateFiles</b>(<i>basename = ""</i>) | |
| 124 <p> | |
| 125 Public method to generate all index files. | |
| 126 </p><dl> | |
| 127 <dt><i>basename</i></dt> | |
| 128 <dd> | |
| 129 The basename of the file hierarchy to be documented. | |
| 130 The basename is stripped off the filename if it starts with | |
| 131 the basename. | |
| 132 </dd> | |
| 133 </dl><a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a> | |
| 134 <h4>QtHelpGenerator.remember</h4> | |
| 135 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) | |
| 136 <p> | |
| 137 Public method to remember a documentation file. | |
| 138 </p><dl> | |
| 139 <dt><i>file</i></dt> | |
| 140 <dd> | |
| 141 The filename to be remembered. (string) | |
| 142 </dd><dt><i>moduleDocument</i></dt> | |
| 143 <dd> | |
| 144 The ModuleDocument object containing the | |
| 145 information for the file. | |
| 146 </dd><dt><i>basename</i></dt> | |
| 147 <dd> | |
| 148 The basename of the file hierarchy to be documented. | |
| 149 The basename is stripped off the filename if it starts with | |
| 150 the basename. | |
| 151 </dd> | |
| 152 </dl> | |
| 153 <div align="right"><a href="#top">Up</a></div> | |
| 154 <hr /> | |
| 155 </body></html> |
