diff options
author | Detlev Casanova <detlev.casanova@gmail.com> | 2010-08-06 20:59:09 +0200 |
---|---|---|
committer | Detlev Casanova <detlev.casanova@gmail.com> | 2010-08-06 20:59:09 +0200 |
commit | f10d3965967d581676beb4c9e529b72dbfb4c672 (patch) | |
tree | 331f674cead2ba137e034c17bfdc64d034df8fb3 /doc/html/group__layman__base.html | |
parent | a3ac6869831b8cce7cd0f738019a0acc2271cbb8 (diff) | |
download | layman-f10d3965967d581676beb4c9e529b72dbfb4c672.tar.gz layman-f10d3965967d581676beb4c9e529b72dbfb4c672.tar.bz2 layman-f10d3965967d581676beb4c9e529b72dbfb4c672.zip |
Add proper Doxygen documentation + it's generated HTML output.
Diffstat (limited to 'doc/html/group__layman__base.html')
-rw-r--r-- | doc/html/group__layman__base.html | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/doc/html/group__layman__base.html b/doc/html/group__layman__base.html new file mode 100644 index 0000000..661aaa7 --- /dev/null +++ b/doc/html/group__layman__base.html @@ -0,0 +1,77 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>C-Layman: Layman base</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.8 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Layman base</h1>Layman Base functions. +<a href="#_details">More...</a> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__base.html#gfc008da53a8f313353af7c53e47b26ad">laymanInit</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__base.html#g57bee932284700150df37b151c8bcf50">laymanFinalize</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Layman Base functions. +<p> +These functions are used when you want to begin or end using the library. <hr><h2>Function Documentation</h2> +<a class="anchor" name="g57bee932284700150df37b151c8bcf50"></a><!-- doxytag: member="interpreter.c::laymanFinalize" ref="g57bee932284700150df37b151c8bcf50" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void laymanFinalize </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Call this function when you're done using the library. It will free memory. +</div> +</div><p> +<a class="anchor" name="gfc008da53a8f313353af7c53e47b26ad"></a><!-- doxytag: member="interpreter.c::laymanInit" ref="gfc008da53a8f313353af7c53e47b26ad" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void laymanInit </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +This is the first function that must be called before using the library. It initializes the Python interpreter. +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Fri Aug 6 20:00:53 2010 for C-Layman by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> +</body> +</html> |