Documentation/Source/eric5.DocumentationTools.APIGenerator.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.DocumentationTools.APIGenerator</title>
<style>
b'body {\n    background:white;\n    margin: 0em 1em 10em 1em;\n    color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n    \na { color: #AA5500; }\n'
</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.DocumentationTools.APIGenerator</h1>
<p>
&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#65;&#80;&#73; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#APIGenerator">APIGenerator</a></td>
<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="APIGenerator" ID="APIGenerator"></a>
<h2>APIGenerator</h2>
<p>
    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;.
</p>
<h3>Derived from</h3>
object
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#APIGenerator.__init__">APIGenerator</a></td>
<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
</tr><tr>
<td><a href="#APIGenerator.__addClassVariablesAPI">__addClassVariablesAPI</a></td>
<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#99;&#108;&#97;&#115;&#115; &#97;&#112;&#105; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#99;&#108;&#97;&#115;&#115; v&#97;&#114;&#105;&#97;&#98;&#108;&#101;&#115;.</td>
</tr><tr>
<td><a href="#APIGenerator.__addClassesAPI">__addClassesAPI</a></td>
<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#97;&#112;&#105; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#99;&#108;&#97;&#115;&#115;&#101;&#115;.</td>
</tr><tr>
<td><a href="#APIGenerator.__addFunctionsAPI">__addFunctionsAPI</a></td>
<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#97;&#112;&#105; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115;.</td>
</tr><tr>
<td><a href="#APIGenerator.__addGlobalsAPI">__addGlobalsAPI</a></td>
<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#97;&#112;&#105; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#103;&#108;&#111;&#98;&#97;&#108; v&#97;&#114;&#105;&#97;&#98;&#108;&#101;&#115;.</td>
</tr><tr>
<td><a href="#APIGenerator.__addMethodsAPI">__addMethodsAPI</a></td>
<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#97;&#112;&#105; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#99;&#108;&#97;&#115;&#115; &#109;&#101;&#116;&#104;&#111;&#100;&#115;.</td>
</tr><tr>
<td><a href="#APIGenerator.__isPrivate">__isPrivate</a></td>
<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#97;&#110; &#111;&#98;&#106;&#101;&#99;&#116; &#105;&#115; &#99;&#111;&#110;&#115;&#105;&#100;&#101;&#114;&#101;&#100; &#112;&#114;&#105;v&#97;&#116;&#101;.</td>
</tr><tr>
<td><a href="#APIGenerator.genAPI">genAPI</a></td>
<td>&#77;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#99;&#111;&#100;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110;.</td>
</tr>
</table>
<a NAME="APIGenerator.__init__" ID="APIGenerator.__init__"></a>
<h4>APIGenerator (Constructor)</h4>
<b>APIGenerator</b>(<i>module</i>)
<p>
        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
</p><dl>
<dt><i>module</i></dt>
<dd>
&#84;&#104;&#101; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#112;&#97;&#114;&#115;&#101;&#100; &#80;y&#116;&#104;&#111;&#110; &#102;&#105;&#108;&#101;.
</dd>
</dl><a NAME="APIGenerator.__addClassVariablesAPI" ID="APIGenerator.__addClassVariablesAPI"></a>
<h4>APIGenerator.__addClassVariablesAPI</h4>
<b>__addClassVariablesAPI</b>(<i>className</i>)
<p>
        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#99;&#108;&#97;&#115;&#115; &#97;&#112;&#105; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#99;&#108;&#97;&#115;&#115; v&#97;&#114;&#105;&#97;&#98;&#108;&#101;&#115;.
</p><dl>
<dt><i>classname</i></dt>
<dd>
&#78;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115; v&#97;&#114;&#105;&#97;&#98;&#108;&#101;&#115;. (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd>
</dl><a NAME="APIGenerator.__addClassesAPI" ID="APIGenerator.__addClassesAPI"></a>
<h4>APIGenerator.__addClassesAPI</h4>
<b>__addClassesAPI</b>(<i></i>)
<p>
        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#97;&#112;&#105; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#99;&#108;&#97;&#115;&#115;&#101;&#115;.
</p><a NAME="APIGenerator.__addFunctionsAPI" ID="APIGenerator.__addFunctionsAPI"></a>
<h4>APIGenerator.__addFunctionsAPI</h4>
<b>__addFunctionsAPI</b>(<i></i>)
<p>
        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#97;&#112;&#105; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115;.
</p><a NAME="APIGenerator.__addGlobalsAPI" ID="APIGenerator.__addGlobalsAPI"></a>
<h4>APIGenerator.__addGlobalsAPI</h4>
<b>__addGlobalsAPI</b>(<i></i>)
<p>
        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#97;&#112;&#105; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#103;&#108;&#111;&#98;&#97;&#108; v&#97;&#114;&#105;&#97;&#98;&#108;&#101;&#115;. 
</p><a NAME="APIGenerator.__addMethodsAPI" ID="APIGenerator.__addMethodsAPI"></a>
<h4>APIGenerator.__addMethodsAPI</h4>
<b>__addMethodsAPI</b>(<i>className</i>)
<p>
        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#97;&#112;&#105; &#115;&#101;&#99;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#99;&#108;&#97;&#115;&#115; &#109;&#101;&#116;&#104;&#111;&#100;&#115;.
</p><dl>
<dt><i>classname</i></dt>
<dd>
&#78;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#109;&#101;&#116;&#104;&#111;&#100;. (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd>
</dl><a NAME="APIGenerator.__isPrivate" ID="APIGenerator.__isPrivate"></a>
<h4>APIGenerator.__isPrivate</h4>
<b>__isPrivate</b>(<i>obj</i>)
<p>
        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#97;&#110; &#111;&#98;&#106;&#101;&#99;&#116; &#105;&#115; &#99;&#111;&#110;&#115;&#105;&#100;&#101;&#114;&#101;&#100; &#112;&#114;&#105;v&#97;&#116;&#101;.
</p><dl>
<dt><i>obj</i></dt>
<dd>
&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#111;&#98;&#106;&#101;&#99;&#116; &#116;&#111; &#98;&#101; &#99;&#104;&#101;&#99;&#107;&#101;&#100;
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103;, &#116;&#104;&#97;&#116; &#111;&#98;&#106;&#101;&#99;&#116; &#105;&#115; &#99;&#111;&#110;&#115;&#105;&#100;&#101;&#114;&#101;&#100; &#112;&#114;&#105;v&#97;&#116;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
</dd>
</dl><a NAME="APIGenerator.genAPI" ID="APIGenerator.genAPI"></a>
<h4>APIGenerator.genAPI</h4>
<b>genAPI</b>(<i>newStyle, basePackage, includePrivate</i>)
<p>
        &#77;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#99;&#111;&#100;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110;.
</p><dl>
<dt><i>newStyle</i></dt>
<dd>
&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#112;&#105; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#81;&#83;&#99;&#105;&#110;&#116;&#105;&#108;&#108;&#97; &#49;.&#55; &#97;&#110;&#100;
            &#110;&#101;w&#101;&#114; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
</dd><dt><i>basePackage</i></dt>
<dd>
&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#98;&#97;&#115;&#101; &#112;&#97;&#99;&#107;&#97;&#103;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd><dt><i>includePrivate</i></dt>
<dd>
&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#111; &#105;&#110;&#99;&#108;&#117;&#100;&#101;
            &#112;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100;&#115;/&#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
&#84;&#104;&#101; &#65;&#80;&#73; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;. (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>