--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.QScintilla.DocstringGenerator.__init__.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,104 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.QScintilla.DocstringGenerator.__init__</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.QScintilla.DocstringGenerator.__init__</h1> + +<p> +Package containing the documentation string generator tool. +</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="#getDocstringGenerator">getDocstringGenerator</a></td> +<td>Function to get a docstring generator for the given editor.</td> +</tr> +<tr> +<td><a href="#getSupportedDocstringTypes">getSupportedDocstringTypes</a></td> +<td>Function to get the supported docstring types/styles.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="getDocstringGenerator" ID="getDocstringGenerator"></a> +<h2>getDocstringGenerator</h2> +<b>getDocstringGenerator</b>(<i>editor</i>) + +<p> + Function to get a docstring generator for the given editor. +</p> +<dl> + +<dt><i>editor</i> (Editor)</dt> +<dd> +reference to the editor to create a docstring generator for +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the created docstring generator +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +BaseDocstringGenerator +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getSupportedDocstringTypes" ID="getSupportedDocstringTypes"></a> +<h2>getSupportedDocstringTypes</h2> +<b>getSupportedDocstringTypes</b>(<i></i>) + +<p> + Function to get the supported docstring types/styles. +</p> +<dl> +<dt>Return:</dt> +<dd> +list of tuples with supported docstring type/style and the + corresponding display string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file