Regenerated source docu.

Mon, 16 Sep 2013 19:57:47 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Mon, 16 Sep 2013 19:57:47 +0200
changeset 2919
b315931c986d
parent 2918
7da821526927
child 2920
054ac3c88754

Regenerated source docu.

APIs/Python3/eric5.api file | annotate | diff | comparison | revisions
Documentation/Help/source.qch file | annotate | diff | comparison | revisions
Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.UtilitiesPython2.Pep257CheckerPy2.html file | annotate | diff | comparison | revisions
Documentation/Source/index-eric5.Plugins.CheckerPlugins.Pep8.html file | annotate | diff | comparison | revisions
Documentation/Source/index-eric5.UtilitiesPython2.html file | annotate | diff | comparison | revisions
--- a/APIs/Python3/eric5.api	Mon Sep 16 19:56:43 2013 +0200
+++ b/APIs/Python3/eric5.api	Mon Sep 16 19:57:47 2013 +0200
@@ -3716,6 +3716,18 @@
 eric5.Plugins.AboutPlugin.AboutDialog.licenseText?7
 eric5.Plugins.AboutPlugin.AboutDialog.thanksText?7
 eric5.Plugins.AboutPlugin.AboutDialog.titleText?7
+eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Checker.Codes?7
+eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Checker.Messages?7
+eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Checker.getMessage?4(code, *args)
+eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Checker.run?4()
+eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Checker?1(source, filename, select, ignore, expected, repeat, maxLineLength=79)
+eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Context.contextType?4()
+eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Context.end?4()
+eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Context.indent?4()
+eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Context.source?4()
+eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Context.ssource?4()
+eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Context.start?4()
+eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Context?1(source, startLine, contextType)
 eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker.Pep8Py2Checker?1(filename, lines, repeat=False, select="", ignore="", max_line_length=79, hang_closing=False)
 eric5.Plugins.CheckerPlugins.Pep8.Pep8CodeSelectionDialog.Pep8CodeSelectionDialog.getSelectedCodes?4()
 eric5.Plugins.CheckerPlugins.Pep8.Pep8CodeSelectionDialog.Pep8CodeSelectionDialog?1(codes, showFixCodes, parent=None)
@@ -8376,6 +8388,16 @@
 eric5.Utilities.win32_Kill?4(pid)
 eric5.Utilities.win32_getRealName?4()
 eric5.Utilities.writeEncodedFile?4(filename, text, orig_coding)
+eric5.UtilitiesPython2.Pep257CheckerPy2.Pep257Checker.Codes?7
+eric5.UtilitiesPython2.Pep257CheckerPy2.Pep257Checker.run?4()
+eric5.UtilitiesPython2.Pep257CheckerPy2.Pep257Checker?1(source, filename, select, ignore, expected, repeat, maxLineLength=79)
+eric5.UtilitiesPython2.Pep257CheckerPy2.Pep257Context.contextType?4()
+eric5.UtilitiesPython2.Pep257CheckerPy2.Pep257Context.end?4()
+eric5.UtilitiesPython2.Pep257CheckerPy2.Pep257Context.indent?4()
+eric5.UtilitiesPython2.Pep257CheckerPy2.Pep257Context.source?4()
+eric5.UtilitiesPython2.Pep257CheckerPy2.Pep257Context.ssource?4()
+eric5.UtilitiesPython2.Pep257CheckerPy2.Pep257Context.start?4()
+eric5.UtilitiesPython2.Pep257CheckerPy2.Pep257Context?1(source, startLine, contextType)
 eric5.UtilitiesPython2.Pep8Checker.Pep8Report.error_args?4(line_number, offset, code, check, *args)
 eric5.UtilitiesPython2.Pep8Checker.Pep8Report.filename?7
 eric5.UtilitiesPython2.Pep8Checker.Pep8Report.hang_closing?7
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Help/source.qhp	Mon Sep 16 19:56:43 2013 +0200
+++ b/Documentation/Help/source.qhp	Mon Sep 16 19:57:47 2013 +0200
@@ -454,6 +454,7 @@
             </section>
             <section title="eric5.Plugins.CheckerPlugins" ref="index-eric5.Plugins.CheckerPlugins.html">
               <section title="eric5.Plugins.CheckerPlugins.Pep8" ref="index-eric5.Plugins.CheckerPlugins.Pep8.html">
+                <section title="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html" />
                 <section title="eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker.html" />
                 <section title="eric5.Plugins.CheckerPlugins.Pep8.Pep8CodeSelectionDialog" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8CodeSelectionDialog.html" />
                 <section title="eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html" />
@@ -969,6 +970,7 @@
               <section title="eric5.UtilitiesPython2.py2flakes.checker" ref="eric5.UtilitiesPython2.py2flakes.checker.html" />
               <section title="eric5.UtilitiesPython2.py2flakes.messages" ref="eric5.UtilitiesPython2.py2flakes.messages.html" />
             </section>
+            <section title="eric5.UtilitiesPython2.Pep257CheckerPy2" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html" />
             <section title="eric5.UtilitiesPython2.Pep8Checker" ref="eric5.UtilitiesPython2.Pep8Checker.html" />
             <section title="eric5.UtilitiesPython2.Pep8NamingCheckerPy2" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html" />
             <section title="eric5.UtilitiesPython2.Py2SyntaxChecker" ref="eric5.UtilitiesPython2.Py2SyntaxChecker.html" />
@@ -7960,6 +7962,89 @@
       <keyword name="PasswordsDialog (Module)" id="PasswordsDialog (Module)" ref="eric5.Helpviewer.Passwords.PasswordsDialog.html" />
       <keyword name="PasswordsDialog.__calculateHeaderSizes" id="PasswordsDialog.__calculateHeaderSizes" ref="eric5.Helpviewer.Passwords.PasswordsDialog.html#PasswordsDialog.__calculateHeaderSizes" />
       <keyword name="PasswordsDialog.on_passwordsButton_clicked" id="PasswordsDialog.on_passwordsButton_clicked" ref="eric5.Helpviewer.Passwords.PasswordsDialog.html#PasswordsDialog.on_passwordsButton_clicked" />
+      <keyword name="Pep257Checker" id="Pep257Checker" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker" />
+      <keyword name="Pep257Checker" id="Pep257Checker" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker" />
+      <keyword name="Pep257Checker (Constructor)" id="Pep257Checker (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__init__" />
+      <keyword name="Pep257Checker (Constructor)" id="Pep257Checker (Constructor)" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__init__" />
+      <keyword name="Pep257Checker (Module)" id="Pep257Checker (Module)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html" />
+      <keyword name="Pep257Checker.__checkBackslashes" id="Pep257Checker.__checkBackslashes" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkBackslashes" />
+      <keyword name="Pep257Checker.__checkBackslashes" id="Pep257Checker.__checkBackslashes" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkBackslashes" />
+      <keyword name="Pep257Checker.__checkBlankAfterLastParagraph" id="Pep257Checker.__checkBlankAfterLastParagraph" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkBlankAfterLastParagraph" />
+      <keyword name="Pep257Checker.__checkBlankAfterLastParagraph" id="Pep257Checker.__checkBlankAfterLastParagraph" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkBlankAfterLastParagraph" />
+      <keyword name="Pep257Checker.__checkBlankAfterSummary" id="Pep257Checker.__checkBlankAfterSummary" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkBlankAfterSummary" />
+      <keyword name="Pep257Checker.__checkBlankAfterSummary" id="Pep257Checker.__checkBlankAfterSummary" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkBlankAfterSummary" />
+      <keyword name="Pep257Checker.__checkBlankBeforeAndAfterClass" id="Pep257Checker.__checkBlankBeforeAndAfterClass" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkBlankBeforeAndAfterClass" />
+      <keyword name="Pep257Checker.__checkBlankBeforeAndAfterClass" id="Pep257Checker.__checkBlankBeforeAndAfterClass" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkBlankBeforeAndAfterClass" />
+      <keyword name="Pep257Checker.__checkClassDocstring" id="Pep257Checker.__checkClassDocstring" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkClassDocstring" />
+      <keyword name="Pep257Checker.__checkClassDocstring" id="Pep257Checker.__checkClassDocstring" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkClassDocstring" />
+      <keyword name="Pep257Checker.__checkEndsWithPeriod" id="Pep257Checker.__checkEndsWithPeriod" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEndsWithPeriod" />
+      <keyword name="Pep257Checker.__checkEndsWithPeriod" id="Pep257Checker.__checkEndsWithPeriod" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkEndsWithPeriod" />
+      <keyword name="Pep257Checker.__checkFunctionDocstring" id="Pep257Checker.__checkFunctionDocstring" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkFunctionDocstring" />
+      <keyword name="Pep257Checker.__checkFunctionDocstring" id="Pep257Checker.__checkFunctionDocstring" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkFunctionDocstring" />
+      <keyword name="Pep257Checker.__checkImperativeMood" id="Pep257Checker.__checkImperativeMood" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkImperativeMood" />
+      <keyword name="Pep257Checker.__checkImperativeMood" id="Pep257Checker.__checkImperativeMood" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkImperativeMood" />
+      <keyword name="Pep257Checker.__checkIndent" id="Pep257Checker.__checkIndent" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkIndent" />
+      <keyword name="Pep257Checker.__checkIndent" id="Pep257Checker.__checkIndent" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkIndent" />
+      <keyword name="Pep257Checker.__checkModulesDocstrings" id="Pep257Checker.__checkModulesDocstrings" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkModulesDocstrings" />
+      <keyword name="Pep257Checker.__checkModulesDocstrings" id="Pep257Checker.__checkModulesDocstrings" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkModulesDocstrings" />
+      <keyword name="Pep257Checker.__checkNoBlankLineBefore" id="Pep257Checker.__checkNoBlankLineBefore" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkNoBlankLineBefore" />
+      <keyword name="Pep257Checker.__checkNoBlankLineBefore" id="Pep257Checker.__checkNoBlankLineBefore" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkNoBlankLineBefore" />
+      <keyword name="Pep257Checker.__checkNoSignature" id="Pep257Checker.__checkNoSignature" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkNoSignature" />
+      <keyword name="Pep257Checker.__checkNoSignature" id="Pep257Checker.__checkNoSignature" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkNoSignature" />
+      <keyword name="Pep257Checker.__checkOneLiner" id="Pep257Checker.__checkOneLiner" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkOneLiner" />
+      <keyword name="Pep257Checker.__checkOneLiner" id="Pep257Checker.__checkOneLiner" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkOneLiner" />
+      <keyword name="Pep257Checker.__checkReturnType" id="Pep257Checker.__checkReturnType" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkReturnType" />
+      <keyword name="Pep257Checker.__checkReturnType" id="Pep257Checker.__checkReturnType" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkReturnType" />
+      <keyword name="Pep257Checker.__checkTripleDoubleQuotes" id="Pep257Checker.__checkTripleDoubleQuotes" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkTripleDoubleQuotes" />
+      <keyword name="Pep257Checker.__checkTripleDoubleQuotes" id="Pep257Checker.__checkTripleDoubleQuotes" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkTripleDoubleQuotes" />
+      <keyword name="Pep257Checker.__checkUnicode" id="Pep257Checker.__checkUnicode" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkUnicode" />
+      <keyword name="Pep257Checker.__checkUnicode" id="Pep257Checker.__checkUnicode" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__checkUnicode" />
+      <keyword name="Pep257Checker.__error" id="Pep257Checker.__error" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__error" />
+      <keyword name="Pep257Checker.__error" id="Pep257Checker.__error" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__error" />
+      <keyword name="Pep257Checker.__getSummaryLine" id="Pep257Checker.__getSummaryLine" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__getSummaryLine" />
+      <keyword name="Pep257Checker.__getSummaryLine" id="Pep257Checker.__getSummaryLine" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__getSummaryLine" />
+      <keyword name="Pep257Checker.__ignoreCode" id="Pep257Checker.__ignoreCode" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__ignoreCode" />
+      <keyword name="Pep257Checker.__ignoreCode" id="Pep257Checker.__ignoreCode" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__ignoreCode" />
+      <keyword name="Pep257Checker.__parseClasses" id="Pep257Checker.__parseClasses" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__parseClasses" />
+      <keyword name="Pep257Checker.__parseClasses" id="Pep257Checker.__parseClasses" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__parseClasses" />
+      <keyword name="Pep257Checker.__parseContexts" id="Pep257Checker.__parseContexts" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__parseContexts" />
+      <keyword name="Pep257Checker.__parseContexts" id="Pep257Checker.__parseContexts" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__parseContexts" />
+      <keyword name="Pep257Checker.__parseDocstring" id="Pep257Checker.__parseDocstring" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__parseDocstring" />
+      <keyword name="Pep257Checker.__parseDocstring" id="Pep257Checker.__parseDocstring" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__parseDocstring" />
+      <keyword name="Pep257Checker.__parseFunctions" id="Pep257Checker.__parseFunctions" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__parseFunctions" />
+      <keyword name="Pep257Checker.__parseFunctions" id="Pep257Checker.__parseFunctions" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__parseFunctions" />
+      <keyword name="Pep257Checker.__parseMethods" id="Pep257Checker.__parseMethods" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__parseMethods" />
+      <keyword name="Pep257Checker.__parseMethods" id="Pep257Checker.__parseMethods" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__parseMethods" />
+      <keyword name="Pep257Checker.__parseModuleDocstring" id="Pep257Checker.__parseModuleDocstring" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__parseModuleDocstring" />
+      <keyword name="Pep257Checker.__parseModuleDocstring" id="Pep257Checker.__parseModuleDocstring" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__parseModuleDocstring" />
+      <keyword name="Pep257Checker.__parseTopLevel" id="Pep257Checker.__parseTopLevel" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__parseTopLevel" />
+      <keyword name="Pep257Checker.__parseTopLevel" id="Pep257Checker.__parseTopLevel" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__parseTopLevel" />
+      <keyword name="Pep257Checker.__readline" id="Pep257Checker.__readline" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__readline" />
+      <keyword name="Pep257Checker.__readline" id="Pep257Checker.__readline" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__readline" />
+      <keyword name="Pep257Checker.__resetReadline" id="Pep257Checker.__resetReadline" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__resetReadline" />
+      <keyword name="Pep257Checker.__resetReadline" id="Pep257Checker.__resetReadline" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__resetReadline" />
+      <keyword name="Pep257Checker.__skipIndentedBlock" id="Pep257Checker.__skipIndentedBlock" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__skipIndentedBlock" />
+      <keyword name="Pep257Checker.__skipIndentedBlock" id="Pep257Checker.__skipIndentedBlock" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.__skipIndentedBlock" />
+      <keyword name="Pep257Checker.getMessage" id="Pep257Checker.getMessage" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.getMessage" />
+      <keyword name="Pep257Checker.run" id="Pep257Checker.run" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.run" />
+      <keyword name="Pep257Checker.run" id="Pep257Checker.run" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Checker.run" />
+      <keyword name="Pep257CheckerPy2 (Module)" id="Pep257CheckerPy2 (Module)" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html" />
+      <keyword name="Pep257Context" id="Pep257Context" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context" />
+      <keyword name="Pep257Context" id="Pep257Context" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Context" />
+      <keyword name="Pep257Context (Constructor)" id="Pep257Context (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context.__init__" />
+      <keyword name="Pep257Context (Constructor)" id="Pep257Context (Constructor)" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Context.__init__" />
+      <keyword name="Pep257Context.contextType" id="Pep257Context.contextType" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context.contextType" />
+      <keyword name="Pep257Context.contextType" id="Pep257Context.contextType" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Context.contextType" />
+      <keyword name="Pep257Context.end" id="Pep257Context.end" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context.end" />
+      <keyword name="Pep257Context.end" id="Pep257Context.end" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Context.end" />
+      <keyword name="Pep257Context.indent" id="Pep257Context.indent" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context.indent" />
+      <keyword name="Pep257Context.indent" id="Pep257Context.indent" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Context.indent" />
+      <keyword name="Pep257Context.source" id="Pep257Context.source" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context.source" />
+      <keyword name="Pep257Context.source" id="Pep257Context.source" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Context.source" />
+      <keyword name="Pep257Context.ssource" id="Pep257Context.ssource" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context.ssource" />
+      <keyword name="Pep257Context.ssource" id="Pep257Context.ssource" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Context.ssource" />
+      <keyword name="Pep257Context.start" id="Pep257Context.start" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context.start" />
+      <keyword name="Pep257Context.start" id="Pep257Context.start" ref="eric5.UtilitiesPython2.Pep257CheckerPy2.html#Pep257Context.start" />
       <keyword name="Pep8 (Package)" id="Pep8 (Package)" ref="index-eric5.Plugins.CheckerPlugins.Pep8.html" />
       <keyword name="Pep8Checker (Module)" id="Pep8Checker (Module)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker.html" />
       <keyword name="Pep8Checker (Module)" id="Pep8Checker (Module)" ref="eric5.UtilitiesPython2.Pep8Checker.html" />
@@ -13635,6 +13720,7 @@
       <file>eric5.PluginManager.PluginRepositoryDialog.html</file>
       <file>eric5.PluginManager.PluginUninstallDialog.html</file>
       <file>eric5.Plugins.AboutPlugin.AboutDialog.html</file>
+      <file>eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html</file>
       <file>eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker.html</file>
       <file>eric5.Plugins.CheckerPlugins.Pep8.Pep8CodeSelectionDialog.html</file>
       <file>eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html</file>
@@ -14040,6 +14126,7 @@
       <file>eric5.Utilities.py3flakes.checker.html</file>
       <file>eric5.Utilities.py3flakes.messages.html</file>
       <file>eric5.Utilities.uic.html</file>
+      <file>eric5.UtilitiesPython2.Pep257CheckerPy2.html</file>
       <file>eric5.UtilitiesPython2.Pep8Checker.html</file>
       <file>eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html</file>
       <file>eric5.UtilitiesPython2.Py2SyntaxChecker.html</file>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html	Mon Sep 16 19:57:47 2013 +0200
@@ -0,0 +1,733 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker</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>eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker</h1>
+<p>
+Module implementing a checker for PEP-257 documentation string conventions.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#Pep257Checker">Pep257Checker</a></td>
+<td>Class implementing a checker for PEP-257 documentation string conventions.</td>
+</tr><tr>
+<td><a href="#Pep257Context">Pep257Context</a></td>
+<td>Class implementing the source context.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="Pep257Checker" ID="Pep257Checker"></a>
+<h2>Pep257Checker</h2>
+<p>
+    Class implementing a checker for PEP-257 documentation string conventions.
+</p>
+<h3>Derived from</h3>
+object
+<h3>Class Attributes</h3>
+<table>
+<tr><td>Codes</td></tr><tr><td>Messages</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#Pep257Checker.__init__">Pep257Checker</a></td>
+<td>Constructor (according to 'extended' pep8.py API)</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkBackslashes">__checkBackslashes</a></td>
+<td>Private method to check, that all docstrings containing backslashes are surrounded by raw triple double quotes.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkBlankAfterLastParagraph">__checkBlankAfterLastParagraph</a></td>
+<td>Private method to check, that docstring summaries are followed by a blank line.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkBlankAfterSummary">__checkBlankAfterSummary</a></td>
+<td>Private method to check, that docstring summaries are followed by a blank line.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkBlankBeforeAndAfterClass">__checkBlankBeforeAndAfterClass</a></td>
+<td>Private method to check, that class docstrings have one blank line around them.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkClassDocstring">__checkClassDocstring</a></td>
+<td>Private method to check, that all public functions and methods have a docstring.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkEndsWithPeriod">__checkEndsWithPeriod</a></td>
+<td>Private method to check, that docstring summaries end with a period.</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>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkImperativeMood">__checkImperativeMood</a></td>
+<td>Private method to check, that docstring summaries are in imperative mood.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkIndent">__checkIndent</a></td>
+<td>Private method to check, that docstrings are properly indented.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkModulesDocstrings">__checkModulesDocstrings</a></td>
+<td>Private method to check, if the module has a docstring.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkNoBlankLineBefore">__checkNoBlankLineBefore</a></td>
+<td>Private method to check, that function/method docstrings are not preceded by a blank line.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkNoSignature">__checkNoSignature</a></td>
+<td>Private method to check, that docstring summaries don't repeat the function's signature.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkOneLiner">__checkOneLiner</a></td>
+<td>Private method to check, that one-liner docstrings fit on one line with quotes.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkReturnType">__checkReturnType</a></td>
+<td>Private method to check, that docstrings mention the return value type.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td>
+<td>Private method to check, that all docstrings are surrounded by triple double quotes.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkUnicode">__checkUnicode</a></td>
+<td>Private method to check, that all docstrings containing unicode characters are surrounded by unicode triple double quotes.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__error">__error</a></td>
+<td>Private method to record an issue.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__getSummaryLine">__getSummaryLine</a></td>
+<td>Private method to extract the summary line.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__ignoreCode">__ignoreCode</a></td>
+<td>Private method to check if the error code should be ignored.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__parseClasses">__parseClasses</a></td>
+<td>Private method to extract top-level classes.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__parseContexts">__parseContexts</a></td>
+<td>Private method to extract a context from the source.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__parseDocstring">__parseDocstring</a></td>
+<td>Private method to extract a docstring given `def` or `class` source.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__parseFunctions">__parseFunctions</a></td>
+<td>Private method to extract top-level functions.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__parseMethods">__parseMethods</a></td>
+<td>Private method to extract methods of all classes.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__parseModuleDocstring">__parseModuleDocstring</a></td>
+<td>Private method to extract a docstring given a module source.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__parseTopLevel">__parseTopLevel</a></td>
+<td>Private method to extract top-level functions or classes.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__readline">__readline</a></td>
+<td>Private method to get the next line from the source.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__resetReadline">__resetReadline</a></td>
+<td>Private method to reset the internal readline function.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__skipIndentedBlock">__skipIndentedBlock</a></td>
+<td>Private method to skip over an indented block of source code.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.getMessage">getMessage</a></td>
+<td>Public method to get a translated and formatted message for a given code.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.run">run</a></td>
+<td>Public method to check the given source for violations of doc string conventions according to PEP-257.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="Pep257Checker.__init__" ID="Pep257Checker.__init__"></a>
+<h4>Pep257Checker (Constructor)</h4>
+<b>Pep257Checker</b>(<i>source, filename, select, ignore, expected, repeat, maxLineLength=79</i>)
+<p>
+        Constructor (according to 'extended' pep8.py API)
+</p><dl>
+<dt><i>source</i></dt>
+<dd>
+source code to be checked (list of string)
+</dd><dt><i>filename</i></dt>
+<dd>
+name of the source file (string)
+</dd><dt><i>select</i></dt>
+<dd>
+list of selected codes (list of string)
+</dd><dt><i>ignore</i></dt>
+<dd>
+list of codes to be ignored (list of string)
+</dd><dt><i>expected</i></dt>
+<dd>
+list of expected codes (list of string)
+</dd><dt><i>repeat</i></dt>
+<dd>
+flag indicating to report each occurrence of a code
+            (boolean)
+</dd><dt><i>maxLineLength</i></dt>
+<dd>
+allowed line length (integer)
+</dd>
+</dl><a NAME="Pep257Checker.__checkBackslashes" ID="Pep257Checker.__checkBackslashes"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkBlankAfterLastParagraph" ID="Pep257Checker.__checkBlankAfterLastParagraph"></a>
+<h4>Pep257Checker.__checkBlankAfterLastParagraph</h4>
+<b>__checkBlankAfterLastParagraph</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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkBlankAfterSummary" ID="Pep257Checker.__checkBlankAfterSummary"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkBlankBeforeAndAfterClass" ID="Pep257Checker.__checkBlankBeforeAndAfterClass"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkClassDocstring" ID="Pep257Checker.__checkClassDocstring"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkEndsWithPeriod" ID="Pep257Checker.__checkEndsWithPeriod"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkFunctionDocstring" ID="Pep257Checker.__checkFunctionDocstring"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkImperativeMood" ID="Pep257Checker.__checkImperativeMood"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkIndent" ID="Pep257Checker.__checkIndent"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkModulesDocstrings" ID="Pep257Checker.__checkModulesDocstrings"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkNoBlankLineBefore" ID="Pep257Checker.__checkNoBlankLineBefore"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkNoSignature" ID="Pep257Checker.__checkNoSignature"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkOneLiner" ID="Pep257Checker.__checkOneLiner"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkReturnType" ID="Pep257Checker.__checkReturnType"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkTripleDoubleQuotes" ID="Pep257Checker.__checkTripleDoubleQuotes"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkUnicode" ID="Pep257Checker.__checkUnicode"></a>
+<h4>Pep257Checker.__checkUnicode</h4>
+<b>__checkUnicode</b>(<i>docstringContext, context</i>)
+<p>
+        Private method to check, that all docstrings containing unicode
+        characters are surrounded by unicode triple double quotes.
+</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.__error" ID="Pep257Checker.__error"></a>
+<h4>Pep257Checker.__error</h4>
+<b>__error</b>(<i>lineNumber, offset, code, *args</i>)
+<p>
+        Private method to record an issue.
+</p><dl>
+<dt><i>lineNumber</i></dt>
+<dd>
+line number of the issue (integer)
+</dd><dt><i>offset</i></dt>
+<dd>
+position within line of the issue (integer)
+</dd><dt><i>code</i></dt>
+<dd>
+message code (string)
+</dd><dt><i>args</i></dt>
+<dd>
+arguments for the message (list)
+</dd>
+</dl><a NAME="Pep257Checker.__getSummaryLine" ID="Pep257Checker.__getSummaryLine"></a>
+<h4>Pep257Checker.__getSummaryLine</h4>
+<b>__getSummaryLine</b>(<i>docstringContext</i>)
+<p>
+        Private method to extract the summary line.
+</p><dl>
+<dt><i>docstringContext</i></dt>
+<dd>
+docstring context (Pep257Context)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+summary line (string) and the line it was found on (integer)
+</dd>
+</dl><a NAME="Pep257Checker.__ignoreCode" ID="Pep257Checker.__ignoreCode"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+message code to check for (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating to ignore the given code (boolean)
+</dd>
+</dl><a NAME="Pep257Checker.__parseClasses" ID="Pep257Checker.__parseClasses"></a>
+<h4>Pep257Checker.__parseClasses</h4>
+<b>__parseClasses</b>(<i></i>)
+<p>
+        Private method to extract top-level classes.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+extracted class contexts (list of Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__parseContexts" ID="Pep257Checker.__parseContexts"></a>
+<h4>Pep257Checker.__parseContexts</h4>
+<b>__parseContexts</b>(<i>kind</i>)
+<p>
+        Private method to extract a context from the source.
+</p><dl>
+<dt><i>kind</i></dt>
+<dd>
+kind of context to extract (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+requested contexts (list of Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__parseDocstring" ID="Pep257Checker.__parseDocstring"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+context data to get the docstring from (Pep257Context)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+context of extracted docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__parseFunctions" ID="Pep257Checker.__parseFunctions"></a>
+<h4>Pep257Checker.__parseFunctions</h4>
+<b>__parseFunctions</b>(<i></i>)
+<p>
+        Private method to extract top-level functions.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+extracted function contexts (list of Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__parseMethods" ID="Pep257Checker.__parseMethods"></a>
+<h4>Pep257Checker.__parseMethods</h4>
+<b>__parseMethods</b>(<i></i>)
+<p>
+        Private method to extract methods of all classes.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+extracted method contexts (list of Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__parseModuleDocstring" ID="Pep257Checker.__parseModuleDocstring"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+source to parse (list of string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+context of extracted docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__parseTopLevel" ID="Pep257Checker.__parseTopLevel"></a>
+<h4>Pep257Checker.__parseTopLevel</h4>
+<b>__parseTopLevel</b>(<i>keyword</i>)
+<p>
+        Private method to extract top-level functions or classes.
+</p><dl>
+<dt><i>keyword</i></dt>
+<dd>
+keyword signaling what to extract (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+extracted function or class contexts (list of Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__readline" ID="Pep257Checker.__readline"></a>
+<h4>Pep257Checker.__readline</h4>
+<b>__readline</b>(<i></i>)
+<p>
+        Private method to get the next line from the source.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+next line of source (string)
+</dd>
+</dl><a NAME="Pep257Checker.__resetReadline" ID="Pep257Checker.__resetReadline"></a>
+<h4>Pep257Checker.__resetReadline</h4>
+<b>__resetReadline</b>(<i></i>)
+<p>
+        Private method to reset the internal readline function.
+</p><a NAME="Pep257Checker.__skipIndentedBlock" ID="Pep257Checker.__skipIndentedBlock"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+token generator
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+last token of the indented block
+</dd>
+</dl><a NAME="Pep257Checker.getMessage" ID="Pep257Checker.getMessage"></a>
+<h4>Pep257Checker.getMessage</h4>
+<b>getMessage</b>(<i>code, *args</i>)
+<p>
+        Public method to get a translated and formatted message for a
+        given code.
+</p><dl>
+<dt><i>code</i></dt>
+<dd>
+message code (string)
+</dd><dt><i>args</i></dt>
+<dd>
+arguments for a formatted message (list)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+translated and formatted message (string)
+</dd>
+</dl><a NAME="Pep257Checker.run" ID="Pep257Checker.run"></a>
+<h4>Pep257Checker.run</h4>
+<b>run</b>(<i></i>)
+<p>
+        Public method to check the given source for violations of doc string
+        conventions according to PEP-257.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="Pep257Context" ID="Pep257Context"></a>
+<h2>Pep257Context</h2>
+<p>
+    Class implementing the source context.
+</p>
+<h3>Derived from</h3>
+object
+<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="#Pep257Context.__init__">Pep257Context</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#Pep257Context.contextType">contextType</a></td>
+<td>Public method to get the context type.</td>
+</tr><tr>
+<td><a href="#Pep257Context.end">end</a></td>
+<td>Public method to get the end line number.</td>
+</tr><tr>
+<td><a href="#Pep257Context.indent">indent</a></td>
+<td>Public method to get the indentation of the first line.</td>
+</tr><tr>
+<td><a href="#Pep257Context.source">source</a></td>
+<td>Public method to get the source.</td>
+</tr><tr>
+<td><a href="#Pep257Context.ssource">ssource</a></td>
+<td>Public method to get the joined source lines.</td>
+</tr><tr>
+<td><a href="#Pep257Context.start">start</a></td>
+<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="Pep257Context.__init__" ID="Pep257Context.__init__"></a>
+<h4>Pep257Context (Constructor)</h4>
+<b>Pep257Context</b>(<i>source, startLine, contextType</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>source</i></dt>
+<dd>
+source code of the context (list of string or string)
+</dd><dt><i>startLine</i></dt>
+<dd>
+line number the context starts in the source (integer)
+</dd><dt><i>contextType</i></dt>
+<dd>
+type of the context object (string)
+</dd>
+</dl><a NAME="Pep257Context.contextType" ID="Pep257Context.contextType"></a>
+<h4>Pep257Context.contextType</h4>
+<b>contextType</b>(<i></i>)
+<p>
+        Public method to get the context type.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+context type (string)
+</dd>
+</dl><a NAME="Pep257Context.end" ID="Pep257Context.end"></a>
+<h4>Pep257Context.end</h4>
+<b>end</b>(<i></i>)
+<p>
+        Public method to get the end line number.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+end line number (integer)
+</dd>
+</dl><a NAME="Pep257Context.indent" ID="Pep257Context.indent"></a>
+<h4>Pep257Context.indent</h4>
+<b>indent</b>(<i></i>)
+<p>
+        Public method to get the indentation of the first line.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+indentation string (string)
+</dd>
+</dl><a NAME="Pep257Context.source" ID="Pep257Context.source"></a>
+<h4>Pep257Context.source</h4>
+<b>source</b>(<i></i>)
+<p>
+        Public method to get the source.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+source (list of string)
+</dd>
+</dl><a NAME="Pep257Context.ssource" ID="Pep257Context.ssource"></a>
+<h4>Pep257Context.ssource</h4>
+<b>ssource</b>(<i></i>)
+<p>
+        Public method to get the joined source lines.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+source (string)
+</dd>
+</dl><a NAME="Pep257Context.start" ID="Pep257Context.start"></a>
+<h4>Pep257Context.start</h4>
+<b>start</b>(<i></i>)
+<p>
+        Public method to get the start line number.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+start line number (integer)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.UtilitiesPython2.Pep257CheckerPy2.html	Mon Sep 16 19:57:47 2013 +0200
@@ -0,0 +1,711 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric5.UtilitiesPython2.Pep257CheckerPy2</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>eric5.UtilitiesPython2.Pep257CheckerPy2</h1>
+<p>
+Module implementing a checker for PEP-257 documentation string conventions.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#Pep257Checker">Pep257Checker</a></td>
+<td>Class implementing a checker for PEP-257 documentation string conventions.</td>
+</tr><tr>
+<td><a href="#Pep257Context">Pep257Context</a></td>
+<td>Class implementing the source context.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="Pep257Checker" ID="Pep257Checker"></a>
+<h2>Pep257Checker</h2>
+<p>
+    Class implementing a checker for PEP-257 documentation string conventions.
+</p>
+<h3>Derived from</h3>
+object
+<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="#Pep257Checker.__init__">Pep257Checker</a></td>
+<td>Constructor (according to 'extended' pep8.py API)</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkBackslashes">__checkBackslashes</a></td>
+<td>Private method to check, that all docstrings containing backslashes are surrounded by raw triple double quotes.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkBlankAfterLastParagraph">__checkBlankAfterLastParagraph</a></td>
+<td>Private method to check, that docstring summaries are followed by a blank line.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkBlankAfterSummary">__checkBlankAfterSummary</a></td>
+<td>Private method to check, that docstring summaries are followed by a blank line.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkBlankBeforeAndAfterClass">__checkBlankBeforeAndAfterClass</a></td>
+<td>Private method to check, that class docstrings have one blank line around them.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkClassDocstring">__checkClassDocstring</a></td>
+<td>Private method to check, that all public functions and methods have a docstring.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkEndsWithPeriod">__checkEndsWithPeriod</a></td>
+<td>Private method to check, that docstring summaries end with a period.</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>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkImperativeMood">__checkImperativeMood</a></td>
+<td>Private method to check, that docstring summaries are in imperative mood.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkIndent">__checkIndent</a></td>
+<td>Private method to check, that docstrings are properly indented.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkModulesDocstrings">__checkModulesDocstrings</a></td>
+<td>Private method to check, if the module has a docstring.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkNoBlankLineBefore">__checkNoBlankLineBefore</a></td>
+<td>Private method to check, that function/method docstrings are not preceded by a blank line.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkNoSignature">__checkNoSignature</a></td>
+<td>Private method to check, that docstring summaries don't repeat the function's signature.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkOneLiner">__checkOneLiner</a></td>
+<td>Private method to check, that one-liner docstrings fit on one line with quotes.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkReturnType">__checkReturnType</a></td>
+<td>Private method to check, that docstrings mention the return value type.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td>
+<td>Private method to check, that all docstrings are surrounded by triple double quotes.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__checkUnicode">__checkUnicode</a></td>
+<td>Private method to check, that all docstrings containing unicode characters are surrounded by unicode triple double quotes.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__error">__error</a></td>
+<td>Private method to record an issue.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__getSummaryLine">__getSummaryLine</a></td>
+<td>Private method to extract the summary line.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__ignoreCode">__ignoreCode</a></td>
+<td>Private method to check if the error code should be ignored.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__parseClasses">__parseClasses</a></td>
+<td>Private method to extract top-level classes.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__parseContexts">__parseContexts</a></td>
+<td>Private method to extract a context from the source.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__parseDocstring">__parseDocstring</a></td>
+<td>Private method to extract a docstring given `def` or `class` source.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__parseFunctions">__parseFunctions</a></td>
+<td>Private method to extract top-level functions.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__parseMethods">__parseMethods</a></td>
+<td>Private method to extract methods of all classes.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__parseModuleDocstring">__parseModuleDocstring</a></td>
+<td>Private method to extract a docstring given a module source.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__parseTopLevel">__parseTopLevel</a></td>
+<td>Private method to extract top-level functions or classes.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__readline">__readline</a></td>
+<td>Private method to get the next line from the source.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__resetReadline">__resetReadline</a></td>
+<td>Private method to reset the internal readline function.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.__skipIndentedBlock">__skipIndentedBlock</a></td>
+<td>Private method to skip over an indented block of source code.</td>
+</tr><tr>
+<td><a href="#Pep257Checker.run">run</a></td>
+<td>Public method to check the given source for violations of doc string conventions according to PEP-257.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="Pep257Checker.__init__" ID="Pep257Checker.__init__"></a>
+<h4>Pep257Checker (Constructor)</h4>
+<b>Pep257Checker</b>(<i>source, filename, select, ignore, expected, repeat, maxLineLength=79</i>)
+<p>
+        Constructor (according to 'extended' pep8.py API)
+</p><dl>
+<dt><i>source</i></dt>
+<dd>
+source code to be checked (list of string)
+</dd><dt><i>filename</i></dt>
+<dd>
+name of the source file (string)
+</dd><dt><i>select</i></dt>
+<dd>
+list of selected codes (list of string)
+</dd><dt><i>ignore</i></dt>
+<dd>
+list of codes to be ignored (list of string)
+</dd><dt><i>expected</i></dt>
+<dd>
+list of expected codes (list of string)
+</dd><dt><i>repeat</i></dt>
+<dd>
+flag indicating to report each occurrence of a code
+            (boolean)
+</dd><dt><i>maxLineLength</i></dt>
+<dd>
+allowed line length (integer)
+</dd>
+</dl><a NAME="Pep257Checker.__checkBackslashes" ID="Pep257Checker.__checkBackslashes"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkBlankAfterLastParagraph" ID="Pep257Checker.__checkBlankAfterLastParagraph"></a>
+<h4>Pep257Checker.__checkBlankAfterLastParagraph</h4>
+<b>__checkBlankAfterLastParagraph</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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkBlankAfterSummary" ID="Pep257Checker.__checkBlankAfterSummary"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkBlankBeforeAndAfterClass" ID="Pep257Checker.__checkBlankBeforeAndAfterClass"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkClassDocstring" ID="Pep257Checker.__checkClassDocstring"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkEndsWithPeriod" ID="Pep257Checker.__checkEndsWithPeriod"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkFunctionDocstring" ID="Pep257Checker.__checkFunctionDocstring"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkImperativeMood" ID="Pep257Checker.__checkImperativeMood"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkIndent" ID="Pep257Checker.__checkIndent"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkModulesDocstrings" ID="Pep257Checker.__checkModulesDocstrings"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkNoBlankLineBefore" ID="Pep257Checker.__checkNoBlankLineBefore"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkNoSignature" ID="Pep257Checker.__checkNoSignature"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkOneLiner" ID="Pep257Checker.__checkOneLiner"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkReturnType" ID="Pep257Checker.__checkReturnType"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkTripleDoubleQuotes" ID="Pep257Checker.__checkTripleDoubleQuotes"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+docstring context (Pep257Context)
+</dd><dt><i>context</i></dt>
+<dd>
+context of the docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__checkUnicode" ID="Pep257Checker.__checkUnicode"></a>
+<h4>Pep257Checker.__checkUnicode</h4>
+<b>__checkUnicode</b>(<i>docstringContext, context</i>)
+<p>
+        Private method to check, that all docstrings containing unicode
+        characters are surrounded by unicode triple double quotes.
+</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.__error" ID="Pep257Checker.__error"></a>
+<h4>Pep257Checker.__error</h4>
+<b>__error</b>(<i>lineNumber, offset, code, *args</i>)
+<p>
+        Private method to record an issue.
+</p><dl>
+<dt><i>lineNumber</i></dt>
+<dd>
+line number of the issue (integer)
+</dd><dt><i>offset</i></dt>
+<dd>
+position within line of the issue (integer)
+</dd><dt><i>code</i></dt>
+<dd>
+message code (string)
+</dd><dt><i>args</i></dt>
+<dd>
+arguments for the message (list)
+</dd>
+</dl><a NAME="Pep257Checker.__getSummaryLine" ID="Pep257Checker.__getSummaryLine"></a>
+<h4>Pep257Checker.__getSummaryLine</h4>
+<b>__getSummaryLine</b>(<i>docstringContext</i>)
+<p>
+        Private method to extract the summary line.
+</p><dl>
+<dt><i>docstringContext</i></dt>
+<dd>
+docstring context (Pep257Context)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+summary line (string) and the line it was found on (integer)
+</dd>
+</dl><a NAME="Pep257Checker.__ignoreCode" ID="Pep257Checker.__ignoreCode"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+message code to check for (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating to ignore the given code (boolean)
+</dd>
+</dl><a NAME="Pep257Checker.__parseClasses" ID="Pep257Checker.__parseClasses"></a>
+<h4>Pep257Checker.__parseClasses</h4>
+<b>__parseClasses</b>(<i></i>)
+<p>
+        Private method to extract top-level classes.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+extracted class contexts (list of Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__parseContexts" ID="Pep257Checker.__parseContexts"></a>
+<h4>Pep257Checker.__parseContexts</h4>
+<b>__parseContexts</b>(<i>kind</i>)
+<p>
+        Private method to extract a context from the source.
+</p><dl>
+<dt><i>kind</i></dt>
+<dd>
+kind of context to extract (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+requested contexts (list of Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__parseDocstring" ID="Pep257Checker.__parseDocstring"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+context data to get the docstring from (Pep257Context)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+context of extracted docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__parseFunctions" ID="Pep257Checker.__parseFunctions"></a>
+<h4>Pep257Checker.__parseFunctions</h4>
+<b>__parseFunctions</b>(<i></i>)
+<p>
+        Private method to extract top-level functions.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+extracted function contexts (list of Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__parseMethods" ID="Pep257Checker.__parseMethods"></a>
+<h4>Pep257Checker.__parseMethods</h4>
+<b>__parseMethods</b>(<i></i>)
+<p>
+        Private method to extract methods of all classes.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+extracted method contexts (list of Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__parseModuleDocstring" ID="Pep257Checker.__parseModuleDocstring"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+source to parse (list of string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+context of extracted docstring (Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__parseTopLevel" ID="Pep257Checker.__parseTopLevel"></a>
+<h4>Pep257Checker.__parseTopLevel</h4>
+<b>__parseTopLevel</b>(<i>keyword</i>)
+<p>
+        Private method to extract top-level functions or classes.
+</p><dl>
+<dt><i>keyword</i></dt>
+<dd>
+keyword signaling what to extract (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+extracted function or class contexts (list of Pep257Context)
+</dd>
+</dl><a NAME="Pep257Checker.__readline" ID="Pep257Checker.__readline"></a>
+<h4>Pep257Checker.__readline</h4>
+<b>__readline</b>(<i></i>)
+<p>
+        Private method to get the next line from the source.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+next line of source (string)
+</dd>
+</dl><a NAME="Pep257Checker.__resetReadline" ID="Pep257Checker.__resetReadline"></a>
+<h4>Pep257Checker.__resetReadline</h4>
+<b>__resetReadline</b>(<i></i>)
+<p>
+        Private method to reset the internal readline function.
+</p><a NAME="Pep257Checker.__skipIndentedBlock" ID="Pep257Checker.__skipIndentedBlock"></a>
+<h4>Pep257Checker.__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></dt>
+<dd>
+token generator
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+last token of the indented block
+</dd>
+</dl><a NAME="Pep257Checker.run" ID="Pep257Checker.run"></a>
+<h4>Pep257Checker.run</h4>
+<b>run</b>(<i></i>)
+<p>
+        Public method to check the given source for violations of doc string
+        conventions according to PEP-257.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="Pep257Context" ID="Pep257Context"></a>
+<h2>Pep257Context</h2>
+<p>
+    Class implementing the source context.
+</p>
+<h3>Derived from</h3>
+object
+<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="#Pep257Context.__init__">Pep257Context</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#Pep257Context.contextType">contextType</a></td>
+<td>Public method to get the context type.</td>
+</tr><tr>
+<td><a href="#Pep257Context.end">end</a></td>
+<td>Public method to get the end line number.</td>
+</tr><tr>
+<td><a href="#Pep257Context.indent">indent</a></td>
+<td>Public method to get the indentation of the first line.</td>
+</tr><tr>
+<td><a href="#Pep257Context.source">source</a></td>
+<td>Public method to get the source.</td>
+</tr><tr>
+<td><a href="#Pep257Context.ssource">ssource</a></td>
+<td>Public method to get the joined source lines.</td>
+</tr><tr>
+<td><a href="#Pep257Context.start">start</a></td>
+<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="Pep257Context.__init__" ID="Pep257Context.__init__"></a>
+<h4>Pep257Context (Constructor)</h4>
+<b>Pep257Context</b>(<i>source, startLine, contextType</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>source</i></dt>
+<dd>
+source code of the context (list of string or string)
+</dd><dt><i>startLine</i></dt>
+<dd>
+line number the context starts in the source (integer)
+</dd><dt><i>contextType</i></dt>
+<dd>
+type of the context object (string)
+</dd>
+</dl><a NAME="Pep257Context.contextType" ID="Pep257Context.contextType"></a>
+<h4>Pep257Context.contextType</h4>
+<b>contextType</b>(<i></i>)
+<p>
+        Public method to get the context type.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+context type (string)
+</dd>
+</dl><a NAME="Pep257Context.end" ID="Pep257Context.end"></a>
+<h4>Pep257Context.end</h4>
+<b>end</b>(<i></i>)
+<p>
+        Public method to get the end line number.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+end line number (integer)
+</dd>
+</dl><a NAME="Pep257Context.indent" ID="Pep257Context.indent"></a>
+<h4>Pep257Context.indent</h4>
+<b>indent</b>(<i></i>)
+<p>
+        Public method to get the indentation of the first line.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+indentation string (string)
+</dd>
+</dl><a NAME="Pep257Context.source" ID="Pep257Context.source"></a>
+<h4>Pep257Context.source</h4>
+<b>source</b>(<i></i>)
+<p>
+        Public method to get the source.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+source (list of string)
+</dd>
+</dl><a NAME="Pep257Context.ssource" ID="Pep257Context.ssource"></a>
+<h4>Pep257Context.ssource</h4>
+<b>ssource</b>(<i></i>)
+<p>
+        Public method to get the joined source lines.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+source (string)
+</dd>
+</dl><a NAME="Pep257Context.start" ID="Pep257Context.start"></a>
+<h4>Pep257Context.start</h4>
+<b>start</b>(<i></i>)
+<p>
+        Public method to get the start line number.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+start line number (integer)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
--- a/Documentation/Source/index-eric5.Plugins.CheckerPlugins.Pep8.html	Mon Sep 16 19:56:43 2013 +0200
+++ b/Documentation/Source/index-eric5.Plugins.CheckerPlugins.Pep8.html	Mon Sep 16 19:57:47 2013 +0200
@@ -28,6 +28,9 @@
 <h3>Modules</h3>
 <table>
 <tr>
+<td><a href="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html">Pep257Checker</a></td>
+<td>Module implementing a checker for PEP-257 documentation string conventions.</td>
+</tr><tr>
 <td><a href="eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker.html">Pep8Checker</a></td>
 <td>Module implementing the PEP 8 checker.</td>
 </tr><tr>
--- a/Documentation/Source/index-eric5.UtilitiesPython2.html	Mon Sep 16 19:56:43 2013 +0200
+++ b/Documentation/Source/index-eric5.UtilitiesPython2.html	Mon Sep 16 19:57:47 2013 +0200
@@ -35,6 +35,9 @@
 <h3>Modules</h3>
 <table>
 <tr>
+<td><a href="eric5.UtilitiesPython2.Pep257CheckerPy2.html">Pep257CheckerPy2</a></td>
+<td>Module implementing a checker for PEP-257 documentation string conventions.</td>
+</tr><tr>
 <td><a href="eric5.UtilitiesPython2.Pep8Checker.html">Pep8Checker</a></td>
 <td>Class implementing the PEP 8 checker for Python2.</td>
 </tr><tr>

eric ide

mercurial