Added doxygen documentation. Now we have to update the comments in all the files. See aide.h and button.h for some examples. Documentation is regenerated by "doxygen Doxyfile" in the root directory

git-svn-id: svn://pulkomandy.tk/GrafX2/trunk@665 416bcca6-2ee7-4201-b75f-2eb2f807beb1
This commit is contained in:
Adrien Destugues
2009-03-06 21:05:05 +00:00
parent b5a1fadbe0
commit 5f50f7bc22
310 changed files with 117783 additions and 2 deletions

View File

@@ -0,0 +1,327 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>GrafX2: Table_conversion Struct Reference</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 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
var num=this.id.replace(/[^[0-9]/g,'');
var button=this.firstChild;
var sectionDiv=document.getElementById('dynsection'+num);
if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
sectionDiv.style.display='block';
button.src='open.gif';
}else{
sectionDiv.style.display='none';
button.src='closed.gif';
}
}
function initDynSections(){
var divs=document.getElementsByTagName('div');
var sectionCounter=1;
for(var i=0;i<divs.length-1;i++){
if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
var header=divs[i];
var section=divs[i+1];
var button=header.firstChild;
if (button!='IMG'){
divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
button=document.createElement('img');
divs[i].insertBefore(button,divs[i].firstChild);
}
header.style.cursor='pointer';
header.onclick=changeDisplayState;
header.id='dynheader'+sectionCounter;
button.src='closed.gif';
section.id='dynsection'+sectionCounter;
section.style.display='none';
section.style.marginLeft='14px';
sectionCounter++;
}
}
}
window.onload = initDynSections;
-->
</script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
<li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Table_conversion Struct Reference</h1><!-- doxytag: class="Table_conversion" --><code>#include &lt;op_c.h&gt;</code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTable__conversion.html#df7f4629dfa909f1f89f98f5abfd0c4e">nbb_r</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTable__conversion.html#c4e7a2a81a7215dd14060cfe17f0f13d">nbb_v</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTable__conversion.html#96956ba312181a51517516ed52218b06">nbb_b</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTable__conversion.html#2f0c4f636d3615d2e04c5d2be8542a8a">rng_r</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTable__conversion.html#5f5d466e018eb4903bf0e0f494ad2018">rng_v</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTable__conversion.html#97e84f24aef33421319d33a014389e01">rng_b</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTable__conversion.html#b12c01d1e04cc09e9481b92fb9804352">dec_r</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTable__conversion.html#3c70df54017d96961dcedfeb8b889358">dec_v</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTable__conversion.html#c95bdd426b8350342c58695e66cc88a8">dec_b</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTable__conversion.html#429d4a5ce8dd2e43d2997a430a595b6d">red_r</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTable__conversion.html#422ff8a260e91d3ba9c17a0dc4526646">red_v</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTable__conversion.html#1525ff44115319b5f49c330fd51ee9bd">red_b</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_8h.html#b8ef12fab634c171394422d0ee8baf94">byte</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTable__conversion.html#4cc96face1e6feca340ea35e09cbae97">table</a></td></tr>
</table>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="df7f4629dfa909f1f89f98f5abfd0c4e"></a><!-- doxytag: member="Table_conversion::nbb_r" ref="df7f4629dfa909f1f89f98f5abfd0c4e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTable__conversion.html#df7f4629dfa909f1f89f98f5abfd0c4e">Table_conversion::nbb_r</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="op__c_8h.html#b0305203bc1199132982edaa6429b49f">TC_New()</a>.</p>
</div>
</div><p>
<a class="anchor" name="c4e7a2a81a7215dd14060cfe17f0f13d"></a><!-- doxytag: member="Table_conversion::nbb_v" ref="c4e7a2a81a7215dd14060cfe17f0f13d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTable__conversion.html#c4e7a2a81a7215dd14060cfe17f0f13d">Table_conversion::nbb_v</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="op__c_8h.html#b0305203bc1199132982edaa6429b49f">TC_New()</a>.</p>
</div>
</div><p>
<a class="anchor" name="96956ba312181a51517516ed52218b06"></a><!-- doxytag: member="Table_conversion::nbb_b" ref="96956ba312181a51517516ed52218b06" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTable__conversion.html#96956ba312181a51517516ed52218b06">Table_conversion::nbb_b</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="op__c_8h.html#b0305203bc1199132982edaa6429b49f">TC_New()</a>.</p>
</div>
</div><p>
<a class="anchor" name="2f0c4f636d3615d2e04c5d2be8542a8a"></a><!-- doxytag: member="Table_conversion::rng_r" ref="2f0c4f636d3615d2e04c5d2be8542a8a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTable__conversion.html#2f0c4f636d3615d2e04c5d2be8542a8a">Table_conversion::rng_r</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="op__c_8h.html#b0305203bc1199132982edaa6429b49f">TC_New()</a>.</p>
</div>
</div><p>
<a class="anchor" name="5f5d466e018eb4903bf0e0f494ad2018"></a><!-- doxytag: member="Table_conversion::rng_v" ref="5f5d466e018eb4903bf0e0f494ad2018" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTable__conversion.html#5f5d466e018eb4903bf0e0f494ad2018">Table_conversion::rng_v</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="op__c_8h.html#b0305203bc1199132982edaa6429b49f">TC_New()</a>.</p>
</div>
</div><p>
<a class="anchor" name="97e84f24aef33421319d33a014389e01"></a><!-- doxytag: member="Table_conversion::rng_b" ref="97e84f24aef33421319d33a014389e01" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTable__conversion.html#97e84f24aef33421319d33a014389e01">Table_conversion::rng_b</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="op__c_8h.html#b0305203bc1199132982edaa6429b49f">TC_New()</a>.</p>
</div>
</div><p>
<a class="anchor" name="b12c01d1e04cc09e9481b92fb9804352"></a><!-- doxytag: member="Table_conversion::dec_r" ref="b12c01d1e04cc09e9481b92fb9804352" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTable__conversion.html#b12c01d1e04cc09e9481b92fb9804352">Table_conversion::dec_r</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="op__c_8h.html#3b90c0526475fd4b9beb16c85cb121e2">TC_Get()</a>, <a class="el" href="op__c_8h.html#b0305203bc1199132982edaa6429b49f">TC_New()</a>, and <a class="el" href="op__c_8h.html#b355c3d5d5e4436789e223c7bf9542e8">TC_Set()</a>.</p>
</div>
</div><p>
<a class="anchor" name="3c70df54017d96961dcedfeb8b889358"></a><!-- doxytag: member="Table_conversion::dec_v" ref="3c70df54017d96961dcedfeb8b889358" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTable__conversion.html#3c70df54017d96961dcedfeb8b889358">Table_conversion::dec_v</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="op__c_8h.html#3b90c0526475fd4b9beb16c85cb121e2">TC_Get()</a>, <a class="el" href="op__c_8h.html#b0305203bc1199132982edaa6429b49f">TC_New()</a>, and <a class="el" href="op__c_8h.html#b355c3d5d5e4436789e223c7bf9542e8">TC_Set()</a>.</p>
</div>
</div><p>
<a class="anchor" name="c95bdd426b8350342c58695e66cc88a8"></a><!-- doxytag: member="Table_conversion::dec_b" ref="c95bdd426b8350342c58695e66cc88a8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTable__conversion.html#c95bdd426b8350342c58695e66cc88a8">Table_conversion::dec_b</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="op__c_8h.html#3b90c0526475fd4b9beb16c85cb121e2">TC_Get()</a>, <a class="el" href="op__c_8h.html#b0305203bc1199132982edaa6429b49f">TC_New()</a>, and <a class="el" href="op__c_8h.html#b355c3d5d5e4436789e223c7bf9542e8">TC_Set()</a>.</p>
</div>
</div><p>
<a class="anchor" name="429d4a5ce8dd2e43d2997a430a595b6d"></a><!-- doxytag: member="Table_conversion::red_r" ref="429d4a5ce8dd2e43d2997a430a595b6d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTable__conversion.html#429d4a5ce8dd2e43d2997a430a595b6d">Table_conversion::red_r</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="op__c_8h.html#3b90c0526475fd4b9beb16c85cb121e2">TC_Get()</a>, and <a class="el" href="op__c_8h.html#b0305203bc1199132982edaa6429b49f">TC_New()</a>.</p>
</div>
</div><p>
<a class="anchor" name="422ff8a260e91d3ba9c17a0dc4526646"></a><!-- doxytag: member="Table_conversion::red_v" ref="422ff8a260e91d3ba9c17a0dc4526646" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTable__conversion.html#422ff8a260e91d3ba9c17a0dc4526646">Table_conversion::red_v</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="op__c_8h.html#3b90c0526475fd4b9beb16c85cb121e2">TC_Get()</a>, and <a class="el" href="op__c_8h.html#b0305203bc1199132982edaa6429b49f">TC_New()</a>.</p>
</div>
</div><p>
<a class="anchor" name="1525ff44115319b5f49c330fd51ee9bd"></a><!-- doxytag: member="Table_conversion::red_b" ref="1525ff44115319b5f49c330fd51ee9bd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTable__conversion.html#1525ff44115319b5f49c330fd51ee9bd">Table_conversion::red_b</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="op__c_8h.html#3b90c0526475fd4b9beb16c85cb121e2">TC_Get()</a>, and <a class="el" href="op__c_8h.html#b0305203bc1199132982edaa6429b49f">TC_New()</a>.</p>
</div>
</div><p>
<a class="anchor" name="4cc96face1e6feca340ea35e09cbae97"></a><!-- doxytag: member="Table_conversion::table" ref="4cc96face1e6feca340ea35e09cbae97" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_8h.html#b8ef12fab634c171394422d0ee8baf94">byte</a>* <a class="el" href="structTable__conversion.html#4cc96face1e6feca340ea35e09cbae97">Table_conversion::table</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="op__c_8h.html#873bf9ef6b61c8ed70017b705ffaaf8c">TC_Delete()</a>, <a class="el" href="op__c_8h.html#3b90c0526475fd4b9beb16c85cb121e2">TC_Get()</a>, <a class="el" href="op__c_8h.html#b0305203bc1199132982edaa6429b49f">TC_New()</a>, and <a class="el" href="op__c_8h.html#b355c3d5d5e4436789e223c7bf9542e8">TC_Set()</a>.</p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="op__c_8h.html">op_c.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 6 16:43:57 2009 for GrafX2 by&nbsp;
<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>