Documentation/Source/eric5.eric5_doc.html

<!DOCTYPE html>
<html><head>
<title>eric5.eric5_doc</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.eric5_doc</h1>
<p>
Eric5 Documentation Generator.
</p><p>
This is the main Python script of the documentation generator. It is
this script that gets called via the source documentation interface.
This script can be used via the commandline as well.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>supportedExtensions</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Functions</h3>
<table>
<tr>
<td><a href="#main">main</a></td>
<td>Main entry point into the application.</td>
</tr><tr>
<td><a href="#usage">usage</a></td>
<td>Function to print some usage information.</td>
</tr><tr>
<td><a href="#version">version</a></td>
<td>Function to show the version information.</td>
</tr>
</table>
<hr /><hr />
<a NAME="main" ID="main"></a>
<h2>main</h2>
<b>main</b>(<i></i>)
<p>
    Main entry point into the application.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="usage" ID="usage"></a>
<h2>usage</h2>
<b>usage</b>(<i></i>)
<p>
    Function to print some usage information.
</p><p>
    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 />
<a NAME="version" ID="version"></a>
<h2>version</h2>
<b>version</b>(<i></i>)
<p>
    Function to show the version information.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>