Documentation/Source/eric5.eric5-api.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.eric5-api.html
--- a/Documentation/Source/eric5.eric5-api.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.eric5-api.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,11 +22,11 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.eric5-api</h1>
 <p>
-&#69;&#114;&#105;&#99;&#53; &#65;&#80;&#73; &#71;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;
+Eric5 API Generator
 </p><p>
-&#84;&#104;&#105;&#115; &#105;&#115; &#116;&#104;&#101; &#109;&#97;&#105;&#110; &#80;y&#116;&#104;&#111;&#110; &#115;&#99;&#114;&#105;&#112;&#116; &#111;&#102; &#116;&#104;&#101; &#65;&#80;&#73; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;. &#73;&#116; &#105;&#115;
-&#116;&#104;&#105;&#115; &#115;&#99;&#114;&#105;&#112;&#116; &#116;&#104;&#97;&#116; &#103;&#101;&#116;&#115; &#99;&#97;&#108;&#108;&#101;&#100; v&#105;&#97; &#116;&#104;&#101; &#65;&#80;&#73; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#105;&#111;&#110; &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101;.
-&#84;&#104;&#105;&#115; &#115;&#99;&#114;&#105;&#112;&#116; &#99;&#97;&#110; &#98;&#101; &#117;&#115;&#101;&#100; v&#105;&#97; &#116;&#104;&#101; &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#97;&#115; w&#101;&#108;&#108;.
+This is the main Python script of the API generator. It is
+this script that gets called via the API generation interface.
+This script can be used via the commandline as well.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -40,13 +40,13 @@
 <table>
 <tr>
 <td><a href="#main">main</a></td>
-<td>&#77;&#97;&#105;&#110; &#101;&#110;&#116;&#114;y &#112;&#111;&#105;&#110;&#116; &#105;&#110;&#116;&#111; &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110;.</td>
+<td>Main entry point into the application.</td>
 </tr><tr>
 <td><a href="#usage">usage</a></td>
-<td>&#70;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#112;&#114;&#105;&#110;&#116; &#115;&#111;&#109;&#101; &#117;&#115;&#97;&#103;&#101; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;.</td>
+<td>Function to print some usage information.</td>
 </tr><tr>
 <td><a href="#version">version</a></td>
-<td>&#70;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; v&#101;&#114;&#115;&#105;&#111;&#110; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;.</td>
+<td>Function to show the version information.</td>
 </tr>
 </table>
 <hr /><hr />
@@ -54,7 +54,7 @@
 <h2>main</h2>
 <b>main</b>(<i></i>)
 <p>
-    &#77;&#97;&#105;&#110; &#101;&#110;&#116;&#114;y &#112;&#111;&#105;&#110;&#116; &#105;&#110;&#116;&#111; &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110;.
+    Main entry point into the application.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -62,10 +62,10 @@
 <h2>usage</h2>
 <b>usage</b>(<i></i>)
 <p>
-    &#70;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#112;&#114;&#105;&#110;&#116; &#115;&#111;&#109;&#101; &#117;&#115;&#97;&#103;&#101; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;.
+    Function to print some usage information.
 </p><p>
-    &#73;&#116; &#112;&#114;&#105;&#110;&#116;&#115; &#97; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#111;&#102; &#97;&#108;&#108; &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115; &#116;&#104;&#97;&#116; &#109;&#97;y
-    &#98;&#101; &#117;&#115;&#101;&#100; &#97;&#110;&#100; &#101;&#110;&#100;&#115; &#116;&#104;&#101; &#97;&#112;&#112;&#108;&#105;&#99;&#97;&#116;&#105;&#111;&#110;.
+    It prints a reference of all commandline parameters that may
+    be used and ends the application.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -73,7 +73,7 @@
 <h2>version</h2>
 <b>version</b>(<i></i>)
 <p>
-    &#70;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; v&#101;&#114;&#115;&#105;&#111;&#110; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;.
+    Function to show the version information.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />

eric ide

mercurial