--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker</h1>
-
<p>
Module implementing a checker for documentation string conventions.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#DocStyleChecker">DocStyleChecker</a></td>
<td>Class implementing a checker for documentation string conventions.</td>
@@ -29,35 +27,34 @@
<td>Class implementing the source context.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="DocStyleChecker" ID="DocStyleChecker"></a>
<h2>DocStyleChecker</h2>
-
<p>
Class implementing a checker for documentation string conventions.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
-
<table>
<tr><td>Codes</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#DocStyleChecker.__init__">DocStyleChecker</a></td>
<td>Constructor</td>
@@ -247,19 +244,20 @@
<td>Public method to check the given source for violations of doc string conventions.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="DocStyleChecker.__init__" ID="DocStyleChecker.__init__"></a>
<h4>DocStyleChecker (Constructor)</h4>
<b>DocStyleChecker</b>(<i>source, filename, select, ignore, expected, repeat, maxLineLength=88, docType="pep257", </i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>source</i> (list of str)</dt>
@@ -298,11 +296,11 @@
<a NAME="DocStyleChecker.__checkBackslashes" ID="DocStyleChecker.__checkBackslashes"></a>
<h4>DocStyleChecker.__checkBackslashes</h4>
<b>__checkBackslashes</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that all docstrings containing
backslashes are surrounded by raw triple double quotes.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -317,11 +315,11 @@
<a NAME="DocStyleChecker.__checkBlankAfterLastParagraph" ID="DocStyleChecker.__checkBlankAfterLastParagraph"></a>
<h4>DocStyleChecker.__checkBlankAfterLastParagraph</h4>
<b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that the last paragraph of docstrings is
followed by a blank line.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -336,11 +334,11 @@
<a NAME="DocStyleChecker.__checkBlankAfterSummary" ID="DocStyleChecker.__checkBlankAfterSummary"></a>
<h4>DocStyleChecker.__checkBlankAfterSummary</h4>
<b>__checkBlankAfterSummary</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that docstring summaries are followed
by a blank line.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -355,11 +353,11 @@
<a NAME="DocStyleChecker.__checkBlankBeforeAndAfterClass" ID="DocStyleChecker.__checkBlankBeforeAndAfterClass"></a>
<h4>DocStyleChecker.__checkBlankBeforeAndAfterClass</h4>
<b>__checkBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that class docstrings have one
blank line around them.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -374,11 +372,11 @@
<a NAME="DocStyleChecker.__checkClassDocstring" ID="DocStyleChecker.__checkClassDocstring"></a>
<h4>DocStyleChecker.__checkClassDocstring</h4>
<b>__checkClassDocstring</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that all public functions and methods
have a docstring.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -393,10 +391,10 @@
<a NAME="DocStyleChecker.__checkEndsWithPeriod" ID="DocStyleChecker.__checkEndsWithPeriod"></a>
<h4>DocStyleChecker.__checkEndsWithPeriod</h4>
<b>__checkEndsWithPeriod</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that docstring summaries end with a period.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -411,11 +409,11 @@
<a NAME="DocStyleChecker.__checkEricBlankAfterSummary" ID="DocStyleChecker.__checkEricBlankAfterSummary"></a>
<h4>DocStyleChecker.__checkEricBlankAfterSummary</h4>
<b>__checkEricBlankAfterSummary</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that docstring summaries are followed
by a blank line.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -430,10 +428,10 @@
<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>
@@ -448,10 +446,10 @@
<a NAME="DocStyleChecker.__checkEricDocumentationIndent" ID="DocStyleChecker.__checkEricDocumentationIndent"></a>
<h4>DocStyleChecker.__checkEricDocumentationIndent</h4>
<b>__checkEricDocumentationIndent</b>(<i>docstringContext, context, </i>)
-
<p>
Private method to check the the correct indentation of the tag lines.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -466,11 +464,11 @@
<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>
@@ -485,10 +483,10 @@
<a NAME="DocStyleChecker.__checkEricEndsWithPeriod" ID="DocStyleChecker.__checkEricEndsWithPeriod"></a>
<h4>DocStyleChecker.__checkEricEndsWithPeriod</h4>
<b>__checkEricEndsWithPeriod</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that docstring summaries end with a period.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -503,7 +501,6 @@
<a NAME="DocStyleChecker.__checkEricException" ID="DocStyleChecker.__checkEricException"></a>
<h4>DocStyleChecker.__checkEricException</h4>
<b>__checkEricException</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that docstrings contain an @exception line
if they raise an exception and don't otherwise.
@@ -513,6 +510,7 @@
completeness (i.e. raised exceptions that are not documented or
documented exceptions that are not raised)
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -527,11 +525,11 @@
<a NAME="DocStyleChecker.__checkEricFunctionArguments" ID="DocStyleChecker.__checkEricFunctionArguments"></a>
<h4>DocStyleChecker.__checkEricFunctionArguments</h4>
<b>__checkEricFunctionArguments</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that docstrings contain an @param and/or
@keyparam line for each argument.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -546,11 +544,11 @@
<a NAME="DocStyleChecker.__checkEricNBlankAfterLastParagraph" ID="DocStyleChecker.__checkEricNBlankAfterLastParagraph"></a>
<h4>DocStyleChecker.__checkEricNBlankAfterLastParagraph</h4>
<b>__checkEricNBlankAfterLastParagraph</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that the last paragraph of docstrings is
not followed by a blank line.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -565,11 +563,11 @@
<a NAME="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a>
<h4>DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction</h4>
<b>__checkEricNoBlankBeforeAndAfterClassOrFunction</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that class and function/method docstrings
have no blank line around them.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -584,11 +582,11 @@
<a NAME="DocStyleChecker.__checkEricQuotesOnSeparateLines" ID="DocStyleChecker.__checkEricQuotesOnSeparateLines"></a>
<h4>DocStyleChecker.__checkEricQuotesOnSeparateLines</h4>
<b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that leading and trailing quotes are on
a line by themselves.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -603,11 +601,11 @@
<a NAME="DocStyleChecker.__checkEricReturn" ID="DocStyleChecker.__checkEricReturn"></a>
<h4>DocStyleChecker.__checkEricReturn</h4>
<b>__checkEricReturn</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that docstrings contain an @return line
if they return anything and don't otherwise.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -622,7 +620,6 @@
<a NAME="DocStyleChecker.__checkEricSignal" ID="DocStyleChecker.__checkEricSignal"></a>
<h4>DocStyleChecker.__checkEricSignal</h4>
<b>__checkEricSignal</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that docstrings contain an @signal line
if they define signals and don't otherwise.
@@ -632,6 +629,7 @@
completeness (i.e. defined signals that are not documented or
documented signals that are not defined)
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -646,11 +644,11 @@
<a NAME="DocStyleChecker.__checkEricSummary" ID="DocStyleChecker.__checkEricSummary"></a>
<h4>DocStyleChecker.__checkEricSummary</h4>
<b>__checkEricSummary</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that method docstring summaries start with
specific words.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -665,11 +663,11 @@
<a NAME="DocStyleChecker.__checkEricYield" ID="DocStyleChecker.__checkEricYield"></a>
<h4>DocStyleChecker.__checkEricYield</h4>
<b>__checkEricYield</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that docstrings contain an @yield line
if they return anything and don't otherwise.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -684,11 +682,11 @@
<a NAME="DocStyleChecker.__checkFunctionDocstring" ID="DocStyleChecker.__checkFunctionDocstring"></a>
<h4>DocStyleChecker.__checkFunctionDocstring</h4>
<b>__checkFunctionDocstring</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that all public functions and methods
have a docstring.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -703,11 +701,11 @@
<a NAME="DocStyleChecker.__checkImperativeMood" ID="DocStyleChecker.__checkImperativeMood"></a>
<h4>DocStyleChecker.__checkImperativeMood</h4>
<b>__checkImperativeMood</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that docstring summaries are in
imperative mood.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -722,10 +720,10 @@
<a NAME="DocStyleChecker.__checkIndent" ID="DocStyleChecker.__checkIndent"></a>
<h4>DocStyleChecker.__checkIndent</h4>
<b>__checkIndent</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that docstrings are properly indented.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -740,10 +738,10 @@
<a NAME="DocStyleChecker.__checkModulesDocstrings" ID="DocStyleChecker.__checkModulesDocstrings"></a>
<h4>DocStyleChecker.__checkModulesDocstrings</h4>
<b>__checkModulesDocstrings</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, if the module has a docstring.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -758,11 +756,11 @@
<a NAME="DocStyleChecker.__checkNoBlankLineBefore" ID="DocStyleChecker.__checkNoBlankLineBefore"></a>
<h4>DocStyleChecker.__checkNoBlankLineBefore</h4>
<b>__checkNoBlankLineBefore</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that function/method docstrings are not
preceded by a blank line.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -777,11 +775,11 @@
<a NAME="DocStyleChecker.__checkNoSignature" ID="DocStyleChecker.__checkNoSignature"></a>
<h4>DocStyleChecker.__checkNoSignature</h4>
<b>__checkNoSignature</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that docstring summaries don't repeat
the function's signature.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -796,11 +794,11 @@
<a NAME="DocStyleChecker.__checkOneLiner" ID="DocStyleChecker.__checkOneLiner"></a>
<h4>DocStyleChecker.__checkOneLiner</h4>
<b>__checkOneLiner</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that one-liner docstrings fit on
one line with quotes.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -815,10 +813,10 @@
<a NAME="DocStyleChecker.__checkReturnType" ID="DocStyleChecker.__checkReturnType"></a>
<h4>DocStyleChecker.__checkReturnType</h4>
<b>__checkReturnType</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that docstrings mention the return value type.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -833,10 +831,10 @@
<a NAME="DocStyleChecker.__checkSummary" ID="DocStyleChecker.__checkSummary"></a>
<h4>DocStyleChecker.__checkSummary</h4>
<b>__checkSummary</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that docstring summaries contain some text.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -851,11 +849,11 @@
<a NAME="DocStyleChecker.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a>
<h4>DocStyleChecker.__checkTripleDoubleQuotes</h4>
<b>__checkTripleDoubleQuotes</b>(<i>docstringContext, context</i>)
-
<p>
Private method to check, that all docstrings are surrounded
by triple double quotes.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -870,10 +868,10 @@
<a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a>
<h4>DocStyleChecker.__error</h4>
<b>__error</b>(<i>lineNumber, offset, code, *args</i>)
-
<p>
Private method to record an issue.
</p>
+
<dl>
<dt><i>lineNumber</i> (int)</dt>
@@ -896,10 +894,10 @@
<a NAME="DocStyleChecker.__getArgNames" ID="DocStyleChecker.__getArgNames"></a>
<h4>DocStyleChecker.__getArgNames</h4>
<b>__getArgNames</b>(<i>node</i>)
-
<p>
Private method to get the argument names of a function node.
</p>
+
<dl>
<dt><i>node</i> (ast.AST)</dt>
@@ -923,10 +921,10 @@
<a NAME="DocStyleChecker.__getSummaryLine" ID="DocStyleChecker.__getSummaryLine"></a>
<h4>DocStyleChecker.__getSummaryLine</h4>
<b>__getSummaryLine</b>(<i>docstringContext</i>)
-
<p>
Private method to extract the summary line.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -949,10 +947,10 @@
<a NAME="DocStyleChecker.__getSummaryLines" ID="DocStyleChecker.__getSummaryLines"></a>
<h4>DocStyleChecker.__getSummaryLines</h4>
<b>__getSummaryLines</b>(<i>docstringContext</i>)
-
<p>
Private method to extract the summary lines.
</p>
+
<dl>
<dt><i>docstringContext</i> (DocStyleContext)</dt>
@@ -975,10 +973,10 @@
<a NAME="DocStyleChecker.__ignoreCode" ID="DocStyleChecker.__ignoreCode"></a>
<h4>DocStyleChecker.__ignoreCode</h4>
<b>__ignoreCode</b>(<i>code</i>)
-
<p>
Private method to check if the error code should be ignored.
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1001,10 +999,10 @@
<a NAME="DocStyleChecker.__parseClasses" ID="DocStyleChecker.__parseClasses"></a>
<h4>DocStyleChecker.__parseClasses</h4>
<b>__parseClasses</b>(<i></i>)
-
<p>
Private method to extract top-level classes.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1020,10 +1018,10 @@
<a NAME="DocStyleChecker.__parseContexts" ID="DocStyleChecker.__parseContexts"></a>
<h4>DocStyleChecker.__parseContexts</h4>
<b>__parseContexts</b>(<i>kind</i>)
-
<p>
Private method to extract a context from the source.
</p>
+
<dl>
<dt><i>kind</i> (str)</dt>
@@ -1046,10 +1044,10 @@
<a NAME="DocStyleChecker.__parseDocstring" ID="DocStyleChecker.__parseDocstring"></a>
<h4>DocStyleChecker.__parseDocstring</h4>
<b>__parseDocstring</b>(<i>context, what=""</i>)
-
<p>
Private method to extract a docstring given `def` or `class` source.
</p>
+
<dl>
<dt><i>context</i> (DocStyleContext)</dt>
@@ -1076,10 +1074,10 @@
<a NAME="DocStyleChecker.__parseFunctions" ID="DocStyleChecker.__parseFunctions"></a>
<h4>DocStyleChecker.__parseFunctions</h4>
<b>__parseFunctions</b>(<i></i>)
-
<p>
Private method to extract top-level functions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1095,10 +1093,10 @@
<a NAME="DocStyleChecker.__parseMethods" ID="DocStyleChecker.__parseMethods"></a>
<h4>DocStyleChecker.__parseMethods</h4>
<b>__parseMethods</b>(<i></i>)
-
<p>
Private method to extract methods of all classes.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1114,10 +1112,10 @@
<a NAME="DocStyleChecker.__parseModuleDocstring" ID="DocStyleChecker.__parseModuleDocstring"></a>
<h4>DocStyleChecker.__parseModuleDocstring</h4>
<b>__parseModuleDocstring</b>(<i>source</i>)
-
<p>
Private method to extract a docstring given a module source.
</p>
+
<dl>
<dt><i>source</i> (list of str)</dt>
@@ -1140,10 +1138,10 @@
<a NAME="DocStyleChecker.__parseTopLevel" ID="DocStyleChecker.__parseTopLevel"></a>
<h4>DocStyleChecker.__parseTopLevel</h4>
<b>__parseTopLevel</b>(<i>keyword</i>)
-
<p>
Private method to extract top-level functions or classes.
</p>
+
<dl>
<dt><i>keyword</i> (str)</dt>
@@ -1166,10 +1164,10 @@
<a NAME="DocStyleChecker.__readline" ID="DocStyleChecker.__readline"></a>
<h4>DocStyleChecker.__readline</h4>
<b>__readline</b>(<i></i>)
-
<p>
Private method to get the next line from the source.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1185,17 +1183,17 @@
<a NAME="DocStyleChecker.__resetReadline" ID="DocStyleChecker.__resetReadline"></a>
<h4>DocStyleChecker.__resetReadline</h4>
<b>__resetReadline</b>(<i></i>)
-
<p>
Private method to reset the internal readline function.
</p>
+
<a NAME="DocStyleChecker.__skipIndentedBlock" ID="DocStyleChecker.__skipIndentedBlock"></a>
<h4>DocStyleChecker.__skipIndentedBlock</h4>
<b>__skipIndentedBlock</b>(<i>tokenGenerator</i>)
-
<p>
Private method to skip over an indented block of source code.
</p>
+
<dl>
<dt><i>tokenGenerator</i> (str iterator)</dt>
@@ -1218,36 +1216,34 @@
<a NAME="DocStyleChecker.run" ID="DocStyleChecker.run"></a>
<h4>DocStyleChecker.run</h4>
<b>run</b>(<i></i>)
-
<p>
Public method to check the given source for violations of doc string
conventions.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="DocStyleContext" ID="DocStyleContext"></a>
<h2>DocStyleContext</h2>
-
<p>
Class implementing the source context.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#DocStyleContext.__init__">DocStyleContext</a></td>
<td>Constructor</td>
@@ -1285,19 +1281,20 @@
<td>Public method to get the start line number.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="DocStyleContext.__init__" ID="DocStyleContext.__init__"></a>
<h4>DocStyleContext (Constructor)</h4>
<b>DocStyleContext</b>(<i>source, startLine, contextType</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>source</i> (list of str or str)</dt>
@@ -1316,10 +1313,10 @@
<a NAME="DocStyleContext.contextType" ID="DocStyleContext.contextType"></a>
<h4>DocStyleContext.contextType</h4>
<b>contextType</b>(<i></i>)
-
<p>
Public method to get the context type.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1335,10 +1332,10 @@
<a NAME="DocStyleContext.end" ID="DocStyleContext.end"></a>
<h4>DocStyleContext.end</h4>
<b>end</b>(<i></i>)
-
<p>
Public method to get the end line number.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1354,10 +1351,10 @@
<a NAME="DocStyleContext.indent" ID="DocStyleContext.indent"></a>
<h4>DocStyleContext.indent</h4>
<b>indent</b>(<i></i>)
-
<p>
Public method to get the indentation of the first line.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1373,10 +1370,10 @@
<a NAME="DocStyleContext.setSpecial" ID="DocStyleContext.setSpecial"></a>
<h4>DocStyleContext.setSpecial</h4>
<b>setSpecial</b>(<i>special</i>)
-
<p>
Public method to set a special attribute for the context.
</p>
+
<dl>
<dt><i>special</i> (str)</dt>
@@ -1387,10 +1384,10 @@
<a NAME="DocStyleContext.source" ID="DocStyleContext.source"></a>
<h4>DocStyleContext.source</h4>
<b>source</b>(<i></i>)
-
<p>
Public method to get the source.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1406,10 +1403,10 @@
<a NAME="DocStyleContext.special" ID="DocStyleContext.special"></a>
<h4>DocStyleContext.special</h4>
<b>special</b>(<i></i>)
-
<p>
Public method to get the special context attribute string.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1425,10 +1422,10 @@
<a NAME="DocStyleContext.ssource" ID="DocStyleContext.ssource"></a>
<h4>DocStyleContext.ssource</h4>
<b>ssource</b>(<i></i>)
-
<p>
Public method to get the joined source lines.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1444,10 +1441,10 @@
<a NAME="DocStyleContext.start" ID="DocStyleContext.start"></a>
<h4>DocStyleContext.start</h4>
<b>start</b>(<i></i>)
-
<p>
Public method to get the start line number.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1462,4 +1459,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
