diff -r e8f41288a688 -r d568932e5185 Documentation/Source/eric5.UtilitiesPython2.Pep257CheckerPy2.html
--- a/Documentation/Source/eric5.UtilitiesPython2.Pep257CheckerPy2.html Sat Sep 28 17:24:00 2013 +0200
+++ b/Documentation/Source/eric5.UtilitiesPython2.Pep257CheckerPy2.html Sat Sep 28 17:24:44 2013 +0200
@@ -87,8 +87,11 @@
<td><a href="#Pep257Checker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td>
<td>Private method to check, that docstring summaries end with a period.</td>
</tr><tr>
+<td><a href="#Pep257Checker.__checkEricException">__checkEricException</a></td>
+<td>Private method to check, that docstrings contain an @exception line if they raise an exception and don't otherwise.</td>
+</tr><tr>
<td><a href="#Pep257Checker.__checkEricFunctionArguments">__checkEricFunctionArguments</a></td>
-<td>Private method to check, that docstrings contain an @param line for each argument.</td>
+<td>Private method to check, that docstrings contain an @param and/or @keyparam line for each argument.</td>
</tr><tr>
<td><a href="#Pep257Checker.__checkEricNBlankAfterLastParagraph">__checkEricNBlankAfterLastParagraph</a></td>
<td>Private method to check, that the last paragraph of docstrings is not followed by a blank line.</td>
@@ -96,11 +99,11 @@
<td><a href="#Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction">__checkEricNoBlankBeforeAndAfterClassOrFunction</a></td>
<td>Private method to check, that class and function/method docstrings have no blank line around them.</td>
</tr><tr>
-<td><a href="#Pep257Checker.__checkEricOneLiner">__checkEricOneLiner</a></td>
-<td>Private method to check, that one-liner docstrings are on three lines (quotes, docstring, quotes).</td>
+<td><a href="#Pep257Checker.__checkEricQuotesOnSeparateLines">__checkEricQuotesOnSeparateLines</a></td>
+<td>Private method to check, that leading and trailing quotes are on a line by themselves.</td>
</tr><tr>
<td><a href="#Pep257Checker.__checkEricReturn">__checkEricReturn</a></td>
-<td>Private method to check, that docstrings contain an @return line.</td>
+<td>Private method to check, that docstrings contain an @return line if they return anything and don't otherwise.</td>
</tr><tr>
<td><a href="#Pep257Checker.__checkFunctionDocstring">__checkFunctionDocstring</a></td>
<td>Private method to check, that all public functions and methods have a docstring.</td>
@@ -331,12 +334,26 @@
<dd>
context of the docstring (Pep257Context)
</dd>
+</dl><a NAME="Pep257Checker.__checkEricException" ID="Pep257Checker.__checkEricException"></a>
+<h4>Pep257Checker.__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.
+</p><dl>
+<dt><i>docstringContext</i></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
</dl><a NAME="Pep257Checker.__checkEricFunctionArguments" ID="Pep257Checker.__checkEricFunctionArguments"></a>
<h4>Pep257Checker.__checkEricFunctionArguments</h4>
<b>__checkEricFunctionArguments</b>(<i>docstringContext, context</i>)
<p>
- Private method to check, that docstrings contain an @param line
- for each argument.
+ Private method to check, that docstrings contain an @param and/or
+ @keyparam line for each argument.
</p><dl>
<dt><i>docstringContext</i></dt>
<dd>
@@ -373,12 +390,12 @@
<dd>
context of the docstring (Pep257Context)
</dd>
-</dl><a NAME="Pep257Checker.__checkEricOneLiner" ID="Pep257Checker.__checkEricOneLiner"></a>
-<h4>Pep257Checker.__checkEricOneLiner</h4>
-<b>__checkEricOneLiner</b>(<i>docstringContext, context</i>)
+</dl><a NAME="Pep257Checker.__checkEricQuotesOnSeparateLines" ID="Pep257Checker.__checkEricQuotesOnSeparateLines"></a>
+<h4>Pep257Checker.__checkEricQuotesOnSeparateLines</h4>
+<b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>)
<p>
- Private method to check, that one-liner docstrings are on
- three lines (quotes, docstring, quotes).
+ Private method to check, that leading and trailing quotes are on
+ a line by themselves.
</p><dl>
<dt><i>docstringContext</i></dt>
<dd>
@@ -391,7 +408,8 @@
<h4>Pep257Checker.__checkEricReturn</h4>
<b>__checkEricReturn</b>(<i>docstringContext, context</i>)
<p>
- Private method to check, that docstrings contain an @return line.
+ Private method to check, that docstrings contain an @return line
+ if they return anything and don't otherwise.
</p><dl>
<dt><i>docstringContext</i></dt>
<dd>
@@ -639,6 +657,9 @@
<dt><i>context</i></dt>
<dd>
context data to get the docstring from (Pep257Context)
+</dd><dt><i>what</i></dt>
+<dd>
+string denoting what is being parsed (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
