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
137
doxydoc/html/structClusterSet.html
Normal file
137
doxydoc/html/structClusterSet.html
Normal file
@@ -0,0 +1,137 @@
|
||||
<!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: ClusterSet 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 Page</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Data 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 Structures</span></a></li>
|
||||
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
|
||||
<li><a href="functions.html"><span>Data Fields</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="contents">
|
||||
<h1>ClusterSet Struct Reference</h1><!-- doxytag: class="ClusterSet" --><code>#include <op_c.h></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 </td><td class="memItemRight" valign="bottom"><a class="el" href="structClusterSet.html#56c7f2614a2cc87c82e8f1f41d4b5382">nb</a></td></tr>
|
||||
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structClusterSet.html#479ce18a3b07828774d6ccd79f020454">nbmax</a></td></tr>
|
||||
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structCluster.html">Cluster</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structClusterSet.html#3c3678e394b52bfbac252397476185e2">clusters</a></td></tr>
|
||||
|
||||
</table>
|
||||
<hr><h2>Field Documentation</h2>
|
||||
<a class="anchor" name="56c7f2614a2cc87c82e8f1f41d4b5382"></a><!-- doxytag: member="ClusterSet::nb" ref="56c7f2614a2cc87c82e8f1f41d4b5382" args="" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int <a class="el" href="structClusterSet.html#56c7f2614a2cc87c82e8f1f41d4b5382">ClusterSet::nb</a> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>
|
||||
|
||||
<p>Referenced by <a class="el" href="op__c_8h.html#553ff769b47a815f759f16889018d611">CS_Generer()</a>, <a class="el" href="op__c_8h.html#3bd2a95f3dc964c62c52fc80b00b3324">CS_Generer_TC_et_Palette()</a>, <a class="el" href="op__c_8h.html#523f157d10af5838a923a80a1eae1e1c">CS_Get()</a>, <a class="el" href="op__c_8h.html#9a3884e53054cb20182351af530002c7">CS_Init()</a>, <a class="el" href="op__c_8h.html#760d8884b10865612773110d736cdffb">CS_Set()</a>, <a class="el" href="op__c_8c.html#63dd9b6dc0c236869bfeedd3d8b4d665">CS_Trier_par_chrominance()</a>, <a class="el" href="op__c_8c.html#cc80173382db71b6eec84f864ddf127a">CS_Trier_par_luminance()</a>, and <a class="el" href="op__c_8h.html#de29e6c6adcd842279942abb5ed0d881">DS_Generer()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div><p>
|
||||
<a class="anchor" name="479ce18a3b07828774d6ccd79f020454"></a><!-- doxytag: member="ClusterSet::nbmax" ref="479ce18a3b07828774d6ccd79f020454" args="" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int <a class="el" href="structClusterSet.html#479ce18a3b07828774d6ccd79f020454">ClusterSet::nbmax</a> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>
|
||||
|
||||
<p>Referenced by <a class="el" href="op__c_8h.html#553ff769b47a815f759f16889018d611">CS_Generer()</a>, <a class="el" href="op__c_8h.html#f8b3c0dfcae67d3d57b40d2b1daa18a8">CS_New()</a>, <a class="el" href="op__c_8c.html#63dd9b6dc0c236869bfeedd3d8b4d665">CS_Trier_par_chrominance()</a>, <a class="el" href="op__c_8c.html#cc80173382db71b6eec84f864ddf127a">CS_Trier_par_luminance()</a>, and <a class="el" href="op__c_8h.html#21a404950a583cfb6509f3d5f466435b">DS_New()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div><p>
|
||||
<a class="anchor" name="3c3678e394b52bfbac252397476185e2"></a><!-- doxytag: member="ClusterSet::clusters" ref="3c3678e394b52bfbac252397476185e2" args="" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="structCluster.html">Cluster</a>* <a class="el" href="structClusterSet.html#3c3678e394b52bfbac252397476185e2">ClusterSet::clusters</a> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>
|
||||
|
||||
<p>Referenced by <a class="el" href="op__c_8h.html#17946039dfa9e3224547a0114909c8f4">CS_Calculer_teintes()</a>, <a class="el" href="op__c_8h.html#d632ba8c5fc7e968dc173a7c7c164657">CS_Delete()</a>, <a class="el" href="op__c_8h.html#3bd2a95f3dc964c62c52fc80b00b3324">CS_Generer_TC_et_Palette()</a>, <a class="el" href="op__c_8h.html#523f157d10af5838a923a80a1eae1e1c">CS_Get()</a>, <a class="el" href="op__c_8h.html#9a3884e53054cb20182351af530002c7">CS_Init()</a>, <a class="el" href="op__c_8h.html#f8b3c0dfcae67d3d57b40d2b1daa18a8">CS_New()</a>, <a class="el" href="op__c_8h.html#760d8884b10865612773110d736cdffb">CS_Set()</a>, <a class="el" href="op__c_8c.html#63dd9b6dc0c236869bfeedd3d8b4d665">CS_Trier_par_chrominance()</a>, <a class="el" href="op__c_8c.html#cc80173382db71b6eec84f864ddf127a">CS_Trier_par_luminance()</a>, <a class="el" href="op__c_8h.html#de29e6c6adcd842279942abb5ed0d881">DS_Generer()</a>, and <a class="el" href="op__c_8h.html#7028ca4a32b1f6a1a72ebc9f42f6e66c">DS_Init()</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
|
||||
<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>
|
||||
Reference in New Issue
Block a user