Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html	Sun Dec 17 17:15:19 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html	Mon Dec 18 16:39:01 2023 +0100
@@ -91,6 +91,14 @@
 <td>Private method to check, that docstring summaries are followed by a blank line.</td>
 </tr>
 <tr>
+<td><a href="#DocStyleChecker.__checkEricDocumentationDeprecatedTags">__checkEricDocumentationDeprecatedTags</a></td>
+<td>Private method to check the use of deprecated documentation tags.</td>
+</tr>
+<tr>
+<td><a href="#DocStyleChecker.__checkEricDocumentationSequence">__checkEricDocumentationSequence</a></td>
+<td>Private method to check, that method docstring follows the correct sequence of entries (e.g.</td>
+</tr>
+<tr>
 <td><a href="#DocStyleChecker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td>
 <td>Private method to check, that docstring summaries end with a period.</td>
 </tr>
@@ -250,39 +258,37 @@
 </p>
 <dl>
 
-<dt><i>source</i></dt>
+<dt><i>source</i> (list of str)</dt>
 <dd>
-source code to be checked (list of string)
+source code to be checked
 </dd>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
-name of the source file (string)
+name of the source file
 </dd>
-<dt><i>select</i></dt>
+<dt><i>select</i> (list of str)</dt>
 <dd>
-list of selected codes (list of string)
+list of selected codes
 </dd>
-<dt><i>ignore</i></dt>
+<dt><i>ignore</i> (list of str)</dt>
 <dd>
-list of codes to be ignored (list of string)
+list of codes to be ignored
 </dd>
-<dt><i>expected</i></dt>
+<dt><i>expected</i> (list of str)</dt>
 <dd>
-list of expected codes (list of string)
+list of expected codes
 </dd>
-<dt><i>repeat</i></dt>
+<dt><i>repeat</i> (bool)</dt>
 <dd>
 flag indicating to report each occurrence of a code
-            (boolean)
 </dd>
-<dt><i>maxLineLength</i></dt>
+<dt><i>maxLineLength</i> (int)</dt>
 <dd>
-allowed line length (integer)
+allowed line length
 </dd>
-<dt><i>docType</i></dt>
+<dt><i>docType</i> (str)</dt>
 <dd>
-type of the documentation strings
-            (string, one of 'eric' or 'pep257')
+type of the documentation strings (one of 'eric' or 'pep257')
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkBackslashes" ID="DocStyleChecker.__checkBackslashes"></a>
@@ -295,13 +301,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkBlankAfterLastParagraph" ID="DocStyleChecker.__checkBlankAfterLastParagraph"></a>
@@ -314,13 +320,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkBlankAfterSummary" ID="DocStyleChecker.__checkBlankAfterSummary"></a>
@@ -333,13 +339,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkBlankBeforeAndAfterClass" ID="DocStyleChecker.__checkBlankBeforeAndAfterClass"></a>
@@ -352,13 +358,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkClassDocstring" ID="DocStyleChecker.__checkClassDocstring"></a>
@@ -371,13 +377,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkEndsWithPeriod" ID="DocStyleChecker.__checkEndsWithPeriod"></a>
@@ -389,13 +395,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkEricBlankAfterSummary" ID="DocStyleChecker.__checkEricBlankAfterSummary"></a>
@@ -408,13 +414,50 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
+<dd>
+docstring context
+</dd>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+context of the docstring
+</dd>
+</dl>
+<a NAME="DocStyleChecker.__checkEricDocumentationDeprecatedTags" ID="DocStyleChecker.__checkEricDocumentationDeprecatedTags"></a>
+<h4>DocStyleChecker.__checkEricDocumentationDeprecatedTags</h4>
+<b>__checkEricDocumentationDeprecatedTags</b>(<i>docstringContext, context, </i>)
+
+<p>
+        Private method to check the use of deprecated documentation tags.
+</p>
+<dl>
+
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
+<dd>
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
+</dd>
+</dl>
+<a NAME="DocStyleChecker.__checkEricDocumentationSequence" ID="DocStyleChecker.__checkEricDocumentationSequence"></a>
+<h4>DocStyleChecker.__checkEricDocumentationSequence</h4>
+<b>__checkEricDocumentationSequence</b>(<i>docstringContext, context, </i>)
+
+<p>
+        Private method to check, that method docstring follows the correct sequence
+        of entries (e.g. @param is followed by @type).
+</p>
+<dl>
+
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
+<dd>
+docstring context
+</dd>
+<dt><i>context</i> (DocStyleContext)</dt>
+<dd>
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkEricEndsWithPeriod" ID="DocStyleChecker.__checkEricEndsWithPeriod"></a>
@@ -426,13 +469,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkEricException" ID="DocStyleChecker.__checkEricException"></a>
@@ -450,13 +493,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkEricFunctionArguments" ID="DocStyleChecker.__checkEricFunctionArguments"></a>
@@ -469,13 +512,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkEricNBlankAfterLastParagraph" ID="DocStyleChecker.__checkEricNBlankAfterLastParagraph"></a>
@@ -488,13 +531,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a>
@@ -507,13 +550,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkEricQuotesOnSeparateLines" ID="DocStyleChecker.__checkEricQuotesOnSeparateLines"></a>
@@ -526,13 +569,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkEricReturn" ID="DocStyleChecker.__checkEricReturn"></a>
@@ -545,13 +588,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkEricSignal" ID="DocStyleChecker.__checkEricSignal"></a>
@@ -569,13 +612,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkEricSummary" ID="DocStyleChecker.__checkEricSummary"></a>
@@ -588,13 +631,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkEricYield" ID="DocStyleChecker.__checkEricYield"></a>
@@ -607,13 +650,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkFunctionDocstring" ID="DocStyleChecker.__checkFunctionDocstring"></a>
@@ -626,13 +669,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkImperativeMood" ID="DocStyleChecker.__checkImperativeMood"></a>
@@ -645,13 +688,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkIndent" ID="DocStyleChecker.__checkIndent"></a>
@@ -663,13 +706,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkModulesDocstrings" ID="DocStyleChecker.__checkModulesDocstrings"></a>
@@ -681,13 +724,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkNoBlankLineBefore" ID="DocStyleChecker.__checkNoBlankLineBefore"></a>
@@ -700,13 +743,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkNoSignature" ID="DocStyleChecker.__checkNoSignature"></a>
@@ -719,13 +762,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkOneLiner" ID="DocStyleChecker.__checkOneLiner"></a>
@@ -738,13 +781,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkReturnType" ID="DocStyleChecker.__checkReturnType"></a>
@@ -756,13 +799,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkSummary" ID="DocStyleChecker.__checkSummary"></a>
@@ -774,13 +817,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a>
@@ -793,13 +836,13 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context of the docstring (DocStyleContext)
+context of the docstring
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a>
@@ -811,21 +854,21 @@
 </p>
 <dl>
 
-<dt><i>lineNumber</i></dt>
+<dt><i>lineNumber</i> (int)</dt>
 <dd>
-line number of the issue (integer)
+line number of the issue
 </dd>
-<dt><i>offset</i></dt>
+<dt><i>offset</i> (int)</dt>
 <dd>
-position within line of the issue (integer)
+position within line of the issue
 </dd>
-<dt><i>code</i></dt>
+<dt><i>code</i> (str)</dt>
 <dd>
-message code (string)
+message code
 </dd>
-<dt><i>args</i></dt>
+<dt><i>args</i> (list)</dt>
 <dd>
-arguments for the message (list)
+arguments for the message
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__getArgNames" ID="DocStyleChecker.__getArgNames"></a>
@@ -837,7 +880,7 @@
 </p>
 <dl>
 
-<dt><i>node</i></dt>
+<dt><i>node</i> (ast.AST)</dt>
 <dd>
 AST node to extract arguments names from
 </dd>
@@ -846,7 +889,13 @@
 <dt>Return:</dt>
 <dd>
 tuple of two list of argument names, one for arguments
-            and one for keyword arguments (tuple of list of string)
+            and one for keyword arguments
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (list of str, list of str)
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__getSummaryLine" ID="DocStyleChecker.__getSummaryLine"></a>
@@ -858,15 +907,21 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-summary line (string) and the line it was found on (integer)
+summary line (string) and the line it was found on
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__getSummaryLines" ID="DocStyleChecker.__getSummaryLines"></a>
@@ -878,16 +933,21 @@
 </p>
 <dl>
 
-<dt><i>docstringContext</i></dt>
+<dt><i>docstringContext</i> (DocStyleContext)</dt>
 <dd>
-docstring context (DocStyleContext)
+docstring context
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 summary lines (list of string) and the line it was found on
-            (integer)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__ignoreCode" ID="DocStyleChecker.__ignoreCode"></a>
@@ -899,15 +959,21 @@
 </p>
 <dl>
 
-<dt><i>code</i></dt>
+<dt><i>code</i> (str)</dt>
 <dd>
-message code to check for (string)
+message code to check for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating to ignore the given code (boolean)
+flag indicating to ignore the given code
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__parseClasses" ID="DocStyleChecker.__parseClasses"></a>
@@ -920,7 +986,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-extracted class contexts (list of DocStyleContext)
+extracted class contexts
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of DocStyleContext
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__parseContexts" ID="DocStyleChecker.__parseContexts"></a>
@@ -932,15 +1004,21 @@
 </p>
 <dl>
 
-<dt><i>kind</i></dt>
+<dt><i>kind</i> (str)</dt>
 <dd>
-kind of context to extract (string)
+kind of context to extract
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-requested contexts (list of DocStyleContext)
+requested contexts
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of DocStyleContext
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__parseDocstring" ID="DocStyleChecker.__parseDocstring"></a>
@@ -952,19 +1030,25 @@
 </p>
 <dl>
 
-<dt><i>context</i></dt>
+<dt><i>context</i> (DocStyleContext)</dt>
 <dd>
-context data to get the docstring from (DocStyleContext)
+context data to get the docstring from
 </dd>
-<dt><i>what</i></dt>
+<dt><i>what</i> (str)</dt>
 <dd>
-string denoting what is being parsed (string)
+string denoting what is being parsed
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-context of extracted docstring (DocStyleContext)
+context of extracted docstring
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+DocStyleContext
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__parseFunctions" ID="DocStyleChecker.__parseFunctions"></a>
@@ -977,7 +1061,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-extracted function contexts (list of DocStyleContext)
+extracted function contexts
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of DocStyleContext
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__parseMethods" ID="DocStyleChecker.__parseMethods"></a>
@@ -990,7 +1080,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-extracted method contexts (list of DocStyleContext)
+extracted method contexts
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of DocStyleContext
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__parseModuleDocstring" ID="DocStyleChecker.__parseModuleDocstring"></a>
@@ -1002,15 +1098,21 @@
 </p>
 <dl>
 
-<dt><i>source</i></dt>
+<dt><i>source</i> (list of str)</dt>
 <dd>
-source to parse (list of string)
+source to parse
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-context of extracted docstring (DocStyleContext)
+context of extracted docstring
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+DocStyleContext
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__parseTopLevel" ID="DocStyleChecker.__parseTopLevel"></a>
@@ -1022,15 +1124,21 @@
 </p>
 <dl>
 
-<dt><i>keyword</i></dt>
+<dt><i>keyword</i> (str)</dt>
 <dd>
-keyword signaling what to extract (string)
+keyword signaling what to extract
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-extracted function or class contexts (list of DocStyleContext)
+extracted function or class contexts
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of DocStyleContext
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__readline" ID="DocStyleChecker.__readline"></a>
@@ -1043,7 +1151,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-next line of source (string)
+next line of source
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="DocStyleChecker.__resetReadline" ID="DocStyleChecker.__resetReadline"></a>
@@ -1062,7 +1176,7 @@
 </p>
 <dl>
 
-<dt><i>tokenGenerator</i></dt>
+<dt><i>tokenGenerator</i> (str iterator)</dt>
 <dd>
 token generator
 </dd>
@@ -1073,6 +1187,12 @@
 last token of the indented block
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple
+</dd>
+</dl>
 <a NAME="DocStyleChecker.run" ID="DocStyleChecker.run"></a>
 <h4>DocStyleChecker.run</h4>
 <b>run</b>(<i></i>)
@@ -1158,17 +1278,17 @@
 </p>
 <dl>
 
-<dt><i>source</i></dt>
+<dt><i>source</i> (list of str or str)</dt>
 <dd>
-source code of the context (list of string or string)
+source code of the context
 </dd>
-<dt><i>startLine</i></dt>
+<dt><i>startLine</i> (int)</dt>
 <dd>
-line number the context starts in the source (integer)
+line number the context starts in the source
 </dd>
-<dt><i>contextType</i></dt>
+<dt><i>contextType</i> (str)</dt>
 <dd>
-type of the context object (string)
+type of the context object
 </dd>
 </dl>
 <a NAME="DocStyleContext.contextType" ID="DocStyleContext.contextType"></a>
@@ -1181,7 +1301,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-context type (string)
+context type
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="DocStyleContext.end" ID="DocStyleContext.end"></a>
@@ -1194,7 +1320,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-end line number (integer)
+end line number
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="DocStyleContext.indent" ID="DocStyleContext.indent"></a>
@@ -1207,7 +1339,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-indentation string (string)
+indentation string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="DocStyleContext.setSpecial" ID="DocStyleContext.setSpecial"></a>
@@ -1234,7 +1372,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-source (list of string)
+source
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="DocStyleContext.special" ID="DocStyleContext.special"></a>
@@ -1266,7 +1410,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-source (string)
+source
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="DocStyleContext.start" ID="DocStyleContext.start"></a>
@@ -1279,7 +1429,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-start line number (integer)
+start line number
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>