src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.GoogledocGenerator.html

branch
eric7
changeset 9503
ae9232bf4854
parent 9209
b99e7fd55fd3
child 10479
856476537696
equal deleted inserted replaced
9502:6091145e189e 9503:ae9232bf4854
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.QScintilla.DocstringGenerator.GoogledocGenerator</h1> 9 <h1>eric7.QScintilla.DocstringGenerator.GoogledocGenerator</h1>
10 10
11 <p> 11 <p>
12 Module implementing the docstring generator for the 'sphinxdoc' style. 12 Module implementing the docstring generator for the 'googledoc' style.
13 </p> 13 </p>
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15
16 <table> 16 <table>
17 <tr><td>None</td></tr> 17 <tr><td>None</td></tr>
24 <h3>Functions</h3> 24 <h3>Functions</h3>
25 25
26 <table> 26 <table>
27 27
28 <tr> 28 <tr>
29 <td><a href="#generateGoogleDoc">generateGoogleDoc</a></td> 29 <td><a href="#generateDoc">generateDoc</a></td>
30 <td>Function to generate the docstring line list iaw.</td> 30 <td>Function to generate the docstring line list iaw.</td>
31 </tr> 31 </tr>
32 </table> 32 </table>
33 <hr /> 33 <hr />
34 <hr /> 34 <hr />
35 <a NAME="generateGoogleDoc" ID="generateGoogleDoc"></a> 35 <a NAME="generateDoc" ID="generateDoc"></a>
36 <h2>generateGoogleDoc</h2> 36 <h2>generateDoc</h2>
37 <b>generateGoogleDoc</b>(<i>functionInfo, editor</i>) 37 <b>generateDoc</b>(<i>functionInfo, editor</i>)
38 38
39 <p> 39 <p>
40 Function to generate the docstring line list iaw. Sphinx documentation 40 Function to generate the docstring line list iaw. Google documentation
41 style. 41 style.
42 </p> 42 </p>
43 <p> 43 <p>
44 Note: Text is created with DESCRIPTION placeholders for descriptions and 44 Note: Text is created with DESCRIPTION placeholders for descriptions and
45 TYPE placeholders for type information 45 TYPE placeholders for type information

eric ide

mercurial