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
174
doxydoc/html/setup_8h.html
Normal file
174
doxydoc/html/setup_8h.html
Normal file
@@ -0,0 +1,174 @@
|
||||
<!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: setup.h File 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><a href="annotated.html"><span>Data Structures</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="tabs">
|
||||
<ul>
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
<li><a href="globals.html"><span>Globals</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="contents">
|
||||
<h1>setup.h File Reference</h1><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="setup_8h.html#855ae078c3fec90b432f7a191fb1864d">Set_Program_Directory</a> (const char *argv0, char *Program_Dir)</td></tr>
|
||||
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="setup_8h.html#0c856157f0055cabc6caa039b21e1675">Set_Data_Directory</a> (const char *Program_Dir, char *Data_Dir)</td></tr>
|
||||
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="setup_8h.html#fd36d70050a4a14b07f890e9b85938b7">Set_Config_Directory</a> (const char *Program_Dir, char *Config_Dir)</td></tr>
|
||||
|
||||
</table>
|
||||
<hr><h2>Function Documentation</h2>
|
||||
<a class="anchor" name="855ae078c3fec90b432f7a191fb1864d"></a><!-- doxytag: member="setup.h::Set_Program_Directory" ref="855ae078c3fec90b432f7a191fb1864d" args="(const char *argv0, char *Program_Dir)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void Set_Program_Directory </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"> <em>argv0</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">char * </td>
|
||||
<td class="paramname"> <em>Program_Dir</em></td><td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>
|
||||
|
||||
</div>
|
||||
</div><p>
|
||||
<a class="anchor" name="0c856157f0055cabc6caa039b21e1675"></a><!-- doxytag: member="setup.h::Set_Data_Directory" ref="0c856157f0055cabc6caa039b21e1675" args="(const char *Program_Dir, char *Data_Dir)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void Set_Data_Directory </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"> <em>Program_Dir</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">char * </td>
|
||||
<td class="paramname"> <em>Data_Dir</em></td><td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>
|
||||
|
||||
<p>Referenced by <a class="el" href="main_8c.html#f089af495e759e0b6aee06c3a0aae867">Initialisation_du_programme()</a>, and <a class="el" href="gfxcfg_8c.html#5c274fba0a05c8c8ec7a73ba47e85e4c">main()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div><p>
|
||||
<a class="anchor" name="fd36d70050a4a14b07f890e9b85938b7"></a><!-- doxytag: member="setup.h::Set_Config_Directory" ref="fd36d70050a4a14b07f890e9b85938b7" args="(const char *Program_Dir, char *Config_Dir)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void Set_Config_Directory </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"> <em>Program_Dir</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">char * </td>
|
||||
<td class="paramname"> <em>Config_Dir</em></td><td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>
|
||||
|
||||
<p>References <a class="el" href="setup_8c.html#68c1b408414a44ee78043dcb3b477c38">Create_ConfigDirectory()</a>, <a class="el" href="io_8c.html#260aa799bda8d9c4cd8dc85c2660d783">Fichier_existe()</a>, <a class="el" href="io_8c.html#900a0a8785e034fbc72f1e52896c1b01">Repertoire_existe()</a>, <a class="el" href="io_8h.html#b64e7b5597e0606838e72f2212b8b2eb">SEPARATEUR_CHEMIN</a>, and <a class="el" href="const_8h.html#902d5031f45feff7645d54db1fb09cc8">TAILLE_CHEMIN_FICHIER</a>.</p>
|
||||
|
||||
<p>Referenced by <a class="el" href="main_8c.html#f089af495e759e0b6aee06c3a0aae867">Initialisation_du_programme()</a>, and <a class="el" href="gfxcfg_8c.html#5c274fba0a05c8c8ec7a73ba47e85e4c">main()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div><p>
|
||||
</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