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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9503
ae9232bf4854
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.SphinxdocGenerator.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,69 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.QScintilla.DocstringGenerator.SphinxdocGenerator</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.QScintilla.DocstringGenerator.SphinxdocGenerator</h1>
+
+<p>
+Module implementing the docstring generator for the 'sphinxdoc' style.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+
+<tr>
+<td><a href="#generateSphinxDoc">generateSphinxDoc</a></td>
+<td>Function to generate the docstring line list iaw.</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="generateSphinxDoc" ID="generateSphinxDoc"></a>
+<h2>generateSphinxDoc</h2>
+<b>generateSphinxDoc</b>(<i>functionInfo</i>)
+
+<p>
+    Function to generate the docstring line list iaw. Sphinx documentation
+    style.
+</p>
+<p>
+    Note: Text is created with DESCRIPTION placeholders for descriptions and
+    TYPE placeholders for type information
+</p>
+<dl>
+
+<dt><i>functionInfo</i> (FunctionInfo)</dt>
+<dd>
+object containing the function information to base
+        the docstring on
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of docstring lines
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial