eric6/Documentation/Source/index-eric6.QScintilla.DocstringGenerator.html

Fri, 22 Jan 2021 16:48:43 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 22 Jan 2021 16:48:43 +0100
changeset 7998
cd41c844862f
permissions
-rw-r--r--

Editor
- added functionality to insert docstring templates via the context menu (cursor placed on first line of function definition) or after entering the docstring start string (e.g. """ for Python)

7998
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric6.QScintilla.DocstringGenerator</title>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <body>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <h1>eric6.QScintilla.DocstringGenerator</h1>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 <p>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 Package containing the documentation string generator tool.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 </p>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 <h3>Modules</h3>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <table>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <tr>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <td><a href="eric6.QScintilla.DocstringGenerator.BaseDocstringGenerator.html">BaseDocstringGenerator</a></td>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <td>Module implementing a docstring generator base class.</td>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 </tr>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 <tr>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <td><a href="eric6.QScintilla.DocstringGenerator.EricdocGenerator.html">EricdocGenerator</a></td>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <td>Module implementing the docstring generator for the 'ericdoc' style.</td>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 </tr>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <tr>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 <td><a href="eric6.QScintilla.DocstringGenerator.GoogledocGenerator.html">GoogledocGenerator</a></td>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <td>Module implementing the docstring generator for the 'sphinxdoc' style.</td>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 </tr>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <tr>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <td><a href="eric6.QScintilla.DocstringGenerator.NumpydocGenerator.html">NumpydocGenerator</a></td>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 <td>Module implementing the docstring generator for the 'numpydoc' style.</td>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 </tr>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <tr>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <td><a href="eric6.QScintilla.DocstringGenerator.PyDocstringGenerator.html">PyDocstringGenerator</a></td>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <td>Module implementing a docstring generator for Python.</td>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 </tr>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <tr>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 <td><a href="eric6.QScintilla.DocstringGenerator.SphinxdocGenerator.html">SphinxdocGenerator</a></td>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 <td>Module implementing the docstring generator for the 'sphinxdoc' style.</td>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 </tr>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 <tr>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <td><a href="eric6.QScintilla.DocstringGenerator.__init__.html">DocstringGenerator</a></td>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <td>Package containing the documentation string generator tool.</td>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 </tr>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 </table>
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 </body></html>

eric ide

mercurial