Mercurial Repositories > eric / file diff

--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html	Thu Jan 02 19:40:08 2014 +0100
+++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html	Fri Jan 03 13:52:58 2014 +0100
@@ -132,6 +132,9 @@
 <td><a href="#DocStyleChecker.__checkReturnType">__checkReturnType</a></td>
 <td>Private method to check, that docstrings mention the return value type.</td>
 </tr><tr>
+<td><a href="#DocStyleChecker.__checkSummary">__checkSummary</a></td>
+<td>Private method to check, that docstring summaries contain some text.</td>
+</tr><tr>
 <td><a href="#DocStyleChecker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td>
 <td>Private method to check, that all docstrings are surrounded by triple double quotes.</td>
 </tr><tr>
@@ -552,6 +555,19 @@
 <dd>
 context of the docstring (DocStyleContext)
 </dd>
+</dl><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></dt>
+<dd>
+docstring context (DocStyleContext)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (DocStyleContext)
+</dd>
 </dl><a NAME="DocStyleChecker.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a>
 <h4>DocStyleChecker.__checkTripleDoubleQuotes</h4>
 <b>__checkTripleDoubleQuotes</b>(<i>docstringContext, context</i>)