Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.QScintilla.DocstringGenerator.__init__.html
eric6/Documentation/Source/eric6.QScintilla.DocstringGenerator.__init__.html
- branch
- maintenance
- changeset 8043
- 0acf98cd089a
- parent 7998
- cd41c844862f
equal
deleted
inserted
replaced
| 7991:866adc8c315b | 8043:0acf98cd089a |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.QScintilla.DocstringGenerator.__init__</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric6.QScintilla.DocstringGenerator.__init__</h1> | |
| 24 | |
| 25 <p> | |
| 26 Package containing the documentation string generator tool. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 <tr><td>None</td></tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 | |
| 40 <table> | |
| 41 | |
| 42 <tr> | |
| 43 <td><a href="#getDocstringGenerator">getDocstringGenerator</a></td> | |
| 44 <td>Function to get a docstring generator for the given editor.</td> | |
| 45 </tr> | |
| 46 <tr> | |
| 47 <td><a href="#getSupportedDocstringTypes">getSupportedDocstringTypes</a></td> | |
| 48 <td>Function to get the supported docstring types/styles.</td> | |
| 49 </tr> | |
| 50 </table> | |
| 51 <hr /> | |
| 52 <hr /> | |
| 53 <a NAME="getDocstringGenerator" ID="getDocstringGenerator"></a> | |
| 54 <h2>getDocstringGenerator</h2> | |
| 55 <b>getDocstringGenerator</b>(<i>editor</i>) | |
| 56 | |
| 57 <p> | |
| 58 Function to get a docstring generator for the given editor. | |
| 59 </p> | |
| 60 <dl> | |
| 61 | |
| 62 <dt><i>editor</i> (Editor)</dt> | |
| 63 <dd> | |
| 64 reference to the editor to create a docstring generator for | |
| 65 </dd> | |
| 66 </dl> | |
| 67 <dl> | |
| 68 <dt>Return:</dt> | |
| 69 <dd> | |
| 70 reference to the created docstring generator | |
| 71 </dd> | |
| 72 </dl> | |
| 73 <dl> | |
| 74 <dt>Return Type:</dt> | |
| 75 <dd> | |
| 76 BaseDocstringGenerator | |
| 77 </dd> | |
| 78 </dl> | |
| 79 <div align="right"><a href="#top">Up</a></div> | |
| 80 <hr /> | |
| 81 <hr /> | |
| 82 <a NAME="getSupportedDocstringTypes" ID="getSupportedDocstringTypes"></a> | |
| 83 <h2>getSupportedDocstringTypes</h2> | |
| 84 <b>getSupportedDocstringTypes</b>(<i></i>) | |
| 85 | |
| 86 <p> | |
| 87 Function to get the supported docstring types/styles. | |
| 88 </p> | |
| 89 <dl> | |
| 90 <dt>Return:</dt> | |
| 91 <dd> | |
| 92 list of tuples with supported docstring type/style and the | |
| 93 corresponding display string | |
| 94 </dd> | |
| 95 </dl> | |
| 96 <dl> | |
| 97 <dt>Return Type:</dt> | |
| 98 <dd> | |
| 99 tuple of (str, str) | |
| 100 </dd> | |
| 101 </dl> | |
| 102 <div align="right"><a href="#top">Up</a></div> | |
| 103 <hr /> | |
| 104 </body></html> |
