Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.__init__.html
src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.__init__.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QScintilla.DocstringGenerator.__init__</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.QScintilla.DocstringGenerator.__init__</h1> | |
| 10 | |
| 11 <p> | |
| 12 Package containing the documentation string generator tool. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 <tr><td>None</td></tr> | |
| 23 </table> | |
| 24 <h3>Functions</h3> | |
| 25 | |
| 26 <table> | |
| 27 | |
| 28 <tr> | |
| 29 <td><a href="#getDocstringGenerator">getDocstringGenerator</a></td> | |
| 30 <td>Function to get a docstring generator for the given editor.</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#getSupportedDocstringTypes">getSupportedDocstringTypes</a></td> | |
| 34 <td>Function to get the supported docstring types/styles.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="getDocstringGenerator" ID="getDocstringGenerator"></a> | |
| 40 <h2>getDocstringGenerator</h2> | |
| 41 <b>getDocstringGenerator</b>(<i>editor</i>) | |
| 42 | |
| 43 <p> | |
| 44 Function to get a docstring generator for the given editor. | |
| 45 </p> | |
| 46 <dl> | |
| 47 | |
| 48 <dt><i>editor</i> (Editor)</dt> | |
| 49 <dd> | |
| 50 reference to the editor to create a docstring generator for | |
| 51 </dd> | |
| 52 </dl> | |
| 53 <dl> | |
| 54 <dt>Return:</dt> | |
| 55 <dd> | |
| 56 reference to the created docstring generator | |
| 57 </dd> | |
| 58 </dl> | |
| 59 <dl> | |
| 60 <dt>Return Type:</dt> | |
| 61 <dd> | |
| 62 BaseDocstringGenerator | |
| 63 </dd> | |
| 64 </dl> | |
| 65 <div align="right"><a href="#top">Up</a></div> | |
| 66 <hr /> | |
| 67 <hr /> | |
| 68 <a NAME="getSupportedDocstringTypes" ID="getSupportedDocstringTypes"></a> | |
| 69 <h2>getSupportedDocstringTypes</h2> | |
| 70 <b>getSupportedDocstringTypes</b>(<i></i>) | |
| 71 | |
| 72 <p> | |
| 73 Function to get the supported docstring types/styles. | |
| 74 </p> | |
| 75 <dl> | |
| 76 <dt>Return:</dt> | |
| 77 <dd> | |
| 78 list of tuples with supported docstring type/style and the | |
| 79 corresponding display string | |
| 80 </dd> | |
| 81 </dl> | |
| 82 <dl> | |
| 83 <dt>Return Type:</dt> | |
| 84 <dd> | |
| 85 tuple of (str, str) | |
| 86 </dd> | |
| 87 </dl> | |
| 88 <div align="right"><a href="#top">Up</a></div> | |
| 89 <hr /> | |
| 90 </body></html> |
