Mercurial Repositories > eric / file diff

diff: Documentation/Source/eric5.DataViews.CodeMetrics.html

Documentation/Source/eric5.DataViews.CodeMetrics.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.DataViews.CodeMetrics.html
--- a/Documentation/Source/eric5.DataViews.CodeMetrics.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.DataViews.CodeMetrics.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,11 +22,11 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.DataViews.CodeMetrics</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#115;&#105;&#109;&#112;&#108;&#101; &#80;y&#116;&#104;&#111;&#110; &#99;&#111;&#100;&#101; &#109;&#101;&#116;&#114;&#105;&#99;&#115; &#97;&#110;&#97;&#108;yz&#101;&#114;.
+Module implementing a simple Python code metrics analyzer.
 </p><dl>
 <dt>Raises <b>ValueError</b>:</dt>
 <dd>
-&#116;&#104;&#101; &#116;&#111;&#107;&#101;&#110;&#105;z&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#105;&#115; &#116;&#111;&#111; &#111;&#108;&#100;
+the tokenize module is too old
 </dd>
 </dl>
 <h3>Global Attributes</h3>
@@ -37,33 +37,33 @@
 <table>
 <tr>
 <td><a href="#Parser">Parser</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#117;&#115;&#101;&#100; &#116;&#111; &#112;&#97;&#114;&#115;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#99;&#111;&#100;&#101; &#111;&#102; &#97; &#80;y&#116;&#104;&#111;&#110; &#102;&#105;&#108;&#101;.</td>
+<td>Class used to parse the source code of a Python file.</td>
 </tr><tr>
 <td><a href="#SourceStat">SourceStat</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#117;&#115;&#101;&#100; &#116;&#111; &#99;&#97;&#108;&#99;&#117;&#108;&#97;&#116;&#101; &#97;&#110;&#100; &#115;&#116;&#111;&#114;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#99;&#111;&#100;&#101; &#115;&#116;&#97;&#116;&#105;&#115;&#116;&#105;&#99;&#115;.</td>
+<td>Class used to calculate and store the source code statistics.</td>
 </tr><tr>
 <td><a href="#Token">Token</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#116;&#111; &#115;&#116;&#111;&#114;&#101; &#116;&#104;&#101; &#116;&#111;&#107;&#101;&#110; &#114;&#101;&#108;&#97;&#116;&#101;&#100; &#105;&#110;&#102;&#111;&#115;.</td>
+<td>Class to store the token related infos.</td>
 </tr>
 </table>
 <h3>Functions</h3>
 <table>
 <tr>
 <td><a href="#analyze">analyze</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#117;&#115;&#101;&#100; &#97;&#110;&#97;&#108;yz&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#111;&#102; &#97; &#80;y&#116;&#104;&#111;&#110; &#102;&#105;&#108;&#101;.</td>
+<td>Module function used analyze the source of a Python file.</td>
 </tr><tr>
 <td><a href="#main">main</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101;&#115; &#109;&#97;&#105;&#110; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#117;&#115;&#101;&#100; w&#104;&#101;&#110; &#99;&#97;&#108;&#108;&#101;&#100; &#97;&#115; &#97; &#115;&#99;&#114;&#105;&#112;&#116;.</td>
+<td>Modules main function used when called as a script.</td>
 </tr><tr>
 <td><a href="#summarize">summarize</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#117;&#115;&#101;&#100; &#116;&#111; &#99;&#111;&#108;&#108;&#101;&#99;&#116; &#111;v&#101;&#114;&#97;&#108;&#108; &#115;&#116;&#97;&#116;&#105;&#115;&#116;&#105;&#99;&#115;.</td>
+<td>Module function used to collect overall statistics.</td>
 </tr>
 </table>
 <hr /><hr />
 <a NAME="Parser" ID="Parser"></a>
 <h2>Parser</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#117;&#115;&#101;&#100; &#116;&#111; &#112;&#97;&#114;&#115;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#99;&#111;&#100;&#101; &#111;&#102; &#97; &#80;y&#116;&#104;&#111;&#110; &#102;&#105;&#108;&#101;.
+    Class used to parse the source code of a Python file.
 </p>
 <h3>Derived from</h3>
 object
@@ -75,43 +75,43 @@
 <table>
 <tr>
 <td><a href="#Parser.__addToken">__addToken</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#97;&#100;&#100; &#97; &#116;&#111;&#107;&#101;&#110; &#116;&#111; &#111;&#117;&#114; &#108;&#105;&#115;&#116; &#111;&#102; &#116;&#111;&#107;&#101;&#110;&#115;.</td>
+<td>Private method used to add a token to our list of tokens.</td>
 </tr><tr>
 <td><a href="#Parser.parse">parse</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#112;&#97;&#114;&#115;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#99;&#111;&#100;&#101;.</td>
+<td>Public method used to parse the source code.</td>
 </tr>
 </table>
 <a NAME="Parser.__addToken" ID="Parser.__addToken"></a>
 <h4>Parser.__addToken</h4>
 <b>__addToken</b>(<i>toktype, toktext, srow, scol, line</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#97;&#100;&#100; &#97; &#116;&#111;&#107;&#101;&#110; &#116;&#111; &#111;&#117;&#114; &#108;&#105;&#115;&#116; &#111;&#102; &#116;&#111;&#107;&#101;&#110;&#115;.
+        Private method used to add a token to our list of tokens.
 </p><dl>
 <dt><i>toktype</i></dt>
 <dd>
-&#116;&#104;&#101; &#116;y&#112;&#101; &#111;&#102; &#116;&#104;&#101; &#116;&#111;&#107;&#101;&#110; (&#105;&#110;&#116;)
+the type of the token (int)
 </dd><dt><i>toktext</i></dt>
 <dd>
-&#116;&#104;&#101; &#116;&#101;x&#116; &#111;&#102; &#116;&#104;&#101; &#116;&#111;&#107;&#101;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+the text of the token (string)
 </dd><dt><i>srow</i></dt>
 <dd>
-&#115;&#116;&#97;&#114;&#116;&#105;&#110;&#103; &#114;&#111;w &#111;&#102; &#116;&#104;&#101; &#116;&#111;&#107;&#101;&#110; (&#105;&#110;&#116;)
+starting row of the token (int)
 </dd><dt><i>scol</i></dt>
 <dd>
-&#115;&#116;&#97;&#114;&#116;&#105;&#110;&#103; &#99;&#111;&#108;&#117;&#109;&#110; &#111;&#102; &#116;&#104;&#101; &#116;&#111;&#107;&#101;&#110; (&#105;&#110;&#116;)
+starting column of the token (int)
 </dd><dt><i>line</i></dt>
 <dd>
-&#108;&#111;&#103;&#105;&#99;&#97;&#108; &#108;&#105;&#110;&#101; &#116;&#104;&#101; &#116;&#111;&#107;&#101;&#110; w&#97;&#115; &#102;&#111;&#117;&#110;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+logical line the token was found (string)
 </dd>
 </dl><a NAME="Parser.parse" ID="Parser.parse"></a>
 <h4>Parser.parse</h4>
 <b>parse</b>(<i>text</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#112;&#97;&#114;&#115;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#99;&#111;&#100;&#101;.
+        Public method used to parse the source code.
 </p><dl>
 <dt><i>text</i></dt>
 <dd>
-&#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#99;&#111;&#100;&#101; &#97;&#115; &#114;&#101;&#97;&#100; &#102;&#114;&#111;&#109; &#97; &#80;y&#116;&#104;&#111;&#110; &#115;&#111;&#117;&#114;&#99;&#101; &#102;&#105;&#108;&#101;
+the source code as read from a Python source file
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -119,7 +119,7 @@
 <a NAME="SourceStat" ID="SourceStat"></a>
 <h2>SourceStat</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#117;&#115;&#101;&#100; &#116;&#111; &#99;&#97;&#108;&#99;&#117;&#108;&#97;&#116;&#101; &#97;&#110;&#100; &#115;&#116;&#111;&#114;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#99;&#111;&#100;&#101; &#115;&#116;&#97;&#116;&#105;&#115;&#116;&#105;&#99;&#115;.
+    Class used to calculate and store the source code statistics.
 </p>
 <h3>Derived from</h3>
 object
@@ -131,100 +131,100 @@
 <table>
 <tr>
 <td><a href="#SourceStat.__init__">SourceStat</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#SourceStat.dedent">dedent</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#100;&#101;&#99;&#114;&#101;&#109;&#101;&#110;&#116; &#116;&#104;&#101; &#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108;.</td>
+<td>Public method used to decrement the indentation level.</td>
 </tr><tr>
 <td><a href="#SourceStat.dump">dump</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#102;&#111;&#114;&#109;&#97;&#116; &#97;&#110;&#100; &#112;&#114;&#105;&#110;&#116; &#116;&#104;&#101; &#99;&#111;&#108;&#108;&#101;&#99;&#116;&#101;&#100; &#115;&#116;&#97;&#116;&#105;&#115;&#116;&#105;&#99;&#115;.</td>
+<td>Public method used to format and print the collected statistics.</td>
 </tr><tr>
 <td><a href="#SourceStat.getCounter">getCounter</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#115;&#112;&#101;&#99;&#105;&#102;&#105;&#99; &#99;&#111;&#117;&#110;&#116;&#101;&#114; v&#97;&#108;&#117;&#101;.</td>
+<td>Public method used to get a specific counter value.</td>
 </tr><tr>
 <td><a href="#SourceStat.inc">inc</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#105;&#110;&#99;&#114;&#101;&#109;&#101;&#110;&#116; &#116;&#104;&#101; v&#97;&#108;&#117;&#101; &#111;&#102; &#97; &#107;&#101;y.</td>
+<td>Public method used to increment the value of a key.</td>
 </tr><tr>
 <td><a href="#SourceStat.indent">indent</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#105;&#110;&#99;&#114;&#101;&#109;&#101;&#110;&#116; &#116;&#104;&#101; &#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108;.</td>
+<td>Public method used to increment the indentation level.</td>
 </tr><tr>
 <td><a href="#SourceStat.push">push</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#115;&#116;&#111;&#114;&#101; &#97;&#110; &#105;&#100;&#101;&#110;&#116;&#105;&#102;&#105;&#101;&#114;.</td>
+<td>Public method used to store an identifier.</td>
 </tr>
 </table>
 <a NAME="SourceStat.__init__" ID="SourceStat.__init__"></a>
 <h4>SourceStat (Constructor)</h4>
 <b>SourceStat</b>(<i></i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><a NAME="SourceStat.dedent" ID="SourceStat.dedent"></a>
 <h4>SourceStat.dedent</h4>
 <b>dedent</b>(<i>tok</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#100;&#101;&#99;&#114;&#101;&#109;&#101;&#110;&#116; &#116;&#104;&#101; &#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108;.
+        Public method used to decrement the indentation level.
 </p><dl>
 <dt><i>tok</i></dt>
 <dd>
-&#116;&#104;&#101; &#116;&#111;&#107;&#101;&#110; &#116;&#111; &#98;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115;&#101;&#100; (&#84;&#111;&#107;&#101;&#110;)
+the token to be processed (Token)
 </dd>
 </dl><a NAME="SourceStat.dump" ID="SourceStat.dump"></a>
 <h4>SourceStat.dump</h4>
 <b>dump</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#102;&#111;&#114;&#109;&#97;&#116; &#97;&#110;&#100; &#112;&#114;&#105;&#110;&#116; &#116;&#104;&#101; &#99;&#111;&#108;&#108;&#101;&#99;&#116;&#101;&#100; &#115;&#116;&#97;&#116;&#105;&#115;&#116;&#105;&#99;&#115;.
+        Public method used to format and print the collected statistics.
 </p><a NAME="SourceStat.getCounter" ID="SourceStat.getCounter"></a>
 <h4>SourceStat.getCounter</h4>
 <b>getCounter</b>(<i>id, key</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#115;&#112;&#101;&#99;&#105;&#102;&#105;&#99; &#99;&#111;&#117;&#110;&#116;&#101;&#114; v&#97;&#108;&#117;&#101;.
+        Public method used to get a specific counter value.
 </p><dl>
 <dt><i>id</i></dt>
 <dd>
-&#105;&#100; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#117;&#110;&#116;&#101;&#114; (&#115;&#116;&#114;&#105;&#110;&#103;)
+id of the counter (string)
 </dd><dt><i>key</i></dt>
 <dd>
-&#107;&#101;y &#111;&#102; &#116;&#104;&#101; v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#114;&#101;&#116;&#114;&#105;&#101;v&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+key of the value to be retrieved (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#104;&#101; v&#97;&#108;&#117;&#101; &#111;&#102; &#116;&#104;&#101; &#114;&#101;&#113;&#117;&#101;&#115;&#116;&#101;&#100; &#99;&#111;&#117;&#110;&#116;&#101;&#114; (&#105;&#110;&#116;)
+the value of the requested counter (int)
 </dd>
 </dl><a NAME="SourceStat.inc" ID="SourceStat.inc"></a>
 <h4>SourceStat.inc</h4>
 <b>inc</b>(<i>key, value=1</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#105;&#110;&#99;&#114;&#101;&#109;&#101;&#110;&#116; &#116;&#104;&#101; v&#97;&#108;&#117;&#101; &#111;&#102; &#97; &#107;&#101;y.
+        Public method used to increment the value of a key.
 </p><dl>
 <dt><i>key</i></dt>
 <dd>
-&#116;&#104;&#101; &#107;&#101;y &#116;&#111; &#98;&#101; &#105;&#110;&#99;&#114;&#101;&#109;&#101;&#110;&#116;&#101;&#100;
+the key to be incremented
 </dd><dt><i>value</i></dt>
 <dd>
-&#116;&#104;&#101; &#105;&#110;&#99;&#114;&#101;&#109;&#101;&#110;&#116; (&#105;&#110;&#116;)
+the increment (int)
 </dd>
 </dl><a NAME="SourceStat.indent" ID="SourceStat.indent"></a>
 <h4>SourceStat.indent</h4>
 <b>indent</b>(<i>tok</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#105;&#110;&#99;&#114;&#101;&#109;&#101;&#110;&#116; &#116;&#104;&#101; &#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108;.
+        Public method used to increment the indentation level.
 </p><dl>
 <dt><i>tok</i></dt>
 <dd>
-&#97; &#116;&#111;&#107;&#101;&#110; (&#84;&#111;&#107;&#101;&#110;, &#105;&#103;&#110;&#111;&#114;&#101;&#100;)
+a token (Token, ignored)
 </dd>
 </dl><a NAME="SourceStat.push" ID="SourceStat.push"></a>
 <h4>SourceStat.push</h4>
 <b>push</b>(<i>identifier, row</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#115;&#116;&#111;&#114;&#101; &#97;&#110; &#105;&#100;&#101;&#110;&#116;&#105;&#102;&#105;&#101;&#114;.
+        Public method used to store an identifier.
 </p><dl>
 <dt><i>identifier</i></dt>
 <dd>
-&#116;&#104;&#101; &#105;&#100;&#101;&#110;&#116;&#105;&#102;&#105;&#101;&#114; &#116;&#111; &#98;&#101; &#114;&#101;&#109;&#101;&#109;&#98;&#101;&#114;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+the identifier to be remembered (string)
 </dd><dt><i>row</i></dt>
 <dd>
-&#116;&#104;&#101; &#114;&#111;w, &#116;&#104;&#101; &#105;&#100;&#101;&#110;&#116;&#105;&#102;&#105;&#101;&#114; &#105;&#115; &#100;&#101;&#102;&#105;&#110;&#101;&#100; &#105;&#110; (&#105;&#110;&#116;)
+the row, the identifier is defined in (int)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -232,7 +232,7 @@
 <a NAME="Token" ID="Token"></a>
 <h2>Token</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#116;&#111; &#115;&#116;&#111;&#114;&#101; &#116;&#104;&#101; &#116;&#111;&#107;&#101;&#110; &#114;&#101;&#108;&#97;&#116;&#101;&#100; &#105;&#110;&#102;&#111;&#115;.
+    Class to store the token related infos.
 </p>
 <h3>Derived from</h3>
 object
@@ -244,18 +244,18 @@
 <table>
 <tr>
 <td><a href="#Token.__init__">Token</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr>
 </table>
 <a NAME="Token.__init__" ID="Token.__init__"></a>
 <h4>Token (Constructor)</h4>
 <b>Token</b>(<i>**kw</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>**kw</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#107;&#101;y, v&#97;&#108;&#117;&#101; &#112;&#97;&#105;&#114;&#115;
+list of key, value pairs
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -266,19 +266,19 @@
 <p>
 
 </p><p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#117;&#115;&#101;&#100; &#97;&#110;&#97;&#108;yz&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#111;&#102; &#97; &#80;y&#116;&#104;&#111;&#110; &#102;&#105;&#108;&#101;.
+    Module function used analyze the source of a Python file.
 </p><dl>
 <dt><i>filename</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#80;y&#116;&#104;&#111;&#110; &#102;&#105;&#108;&#101; &#116;&#111; &#98;&#101; &#97;&#110;&#97;&#108;yz&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the Python file to be analyzed (string)
 </dd><dt><i>total</i></dt>
 <dd>
-&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#114;&#101;&#99;&#101;&#105;v&#105;&#110;&#103; &#116;&#104;&#101; &#111;v&#101;&#114;&#97;&#108;&#108; &#99;&#111;&#100;&#101; &#115;&#116;&#97;&#116;&#105;&#115;&#116;&#105;&#99;&#115;
+dictionary receiving the overall code statistics
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#97; &#115;&#116;&#97;&#116;&#105;&#115;&#116;&#105;&#99;&#115; &#111;&#98;&#106;&#101;&#99;&#116; w&#105;&#116;&#104; &#116;&#104;&#101; &#99;&#111;&#108;&#108;&#101;&#99;&#116;&#101;&#100; &#99;&#111;&#100;&#101; &#115;&#116;&#97;&#116;&#105;&#115;&#116;&#105;&#99;&#115; (&#83;&#111;&#117;&#114;&#99;&#101;&#83;&#116;&#97;&#116;)
+a statistics object with the collected code statistics (SourceStat)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -287,10 +287,10 @@
 <h2>main</h2>
 <b>main</b>(<i></i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101;&#115; &#109;&#97;&#105;&#110; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#117;&#115;&#101;&#100; w&#104;&#101;&#110; &#99;&#97;&#108;&#108;&#101;&#100; &#97;&#115; &#97; &#115;&#99;&#114;&#105;&#112;&#116;.
+    Modules main function used when called as a script.
 </p><p>
-    &#84;&#104;&#105;&#115; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#115;&#105;&#109;&#112;&#108;y &#108;&#111;&#111;&#112;&#115; &#111;v&#101;&#114; &#97;&#108;&#108; &#102;&#105;&#108;&#101;&#115; &#103;&#105;v&#101;&#110; &#111;&#110; &#116;&#104;&#101; &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101;
-    &#97;&#110;&#100; &#99;&#111;&#108;&#108;&#101;&#99;&#116;&#115; &#116;&#104;&#101; &#105;&#110;&#100;&#105;v&#105;&#100;&#117;&#97;&#108; &#97;&#110;&#100; &#111;v&#101;&#114;&#97;&#108;&#108; &#115;&#111;&#117;&#114;&#99;&#101; &#99;&#111;&#100;&#101; &#115;&#116;&#97;&#116;&#105;&#115;&#116;&#105;&#99;&#115;.
+    This function simply loops over all files given on the commandline
+    and collects the individual and overall source code statistics.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -298,22 +298,22 @@
 <h2>summarize</h2>
 <b>summarize</b>(<i>total, key, value</i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#117;&#115;&#101;&#100; &#116;&#111; &#99;&#111;&#108;&#108;&#101;&#99;&#116; &#111;v&#101;&#114;&#97;&#108;&#108; &#115;&#116;&#97;&#116;&#105;&#115;&#116;&#105;&#99;&#115;.
+    Module function used to collect overall statistics.
 </p><dl>
 <dt><i>total</i></dt>
 <dd>
-&#116;&#104;&#101; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#102;&#111;&#114; &#116;&#104;&#101; &#111;v&#101;&#114;&#97;&#108;&#108; &#115;&#116;&#97;&#116;&#105;&#115;&#116;&#105;&#99;&#115;
+the dictionary for the overall statistics
 </dd><dt><i>key</i></dt>
 <dd>
-&#116;&#104;&#101; &#107;&#101;y &#116;&#111; &#98;&#101; &#115;&#117;&#109;&#109;&#97;&#114;&#105;z&#101;
+the key to be summarize
 </dd><dt><i>value</i></dt>
 <dd>
-&#116;&#104;&#101; v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#97;&#100;&#100;&#101;&#100; &#116;&#111; &#116;&#104;&#101; &#111;v&#101;&#114;&#97;&#108;&#108; &#115;&#116;&#97;&#116;&#105;&#115;&#116;&#105;&#99;&#115;
+the value to be added to the overall statistics
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#104;&#101; v&#97;&#108;&#117;&#101; &#97;&#100;&#100;&#101;&#100; &#116;&#111; &#116;&#104;&#101; &#111;v&#101;&#114;&#97;&#108;&#108; &#115;&#116;&#97;&#116;&#105;&#115;&#116;&#105;&#99;&#115;
+the value added to the overall statistics
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial