m/grafX2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

177
doxydoc/html/aide_8h.html Normal file
View File

@@ -0,0 +1,177 @@
<!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: aide.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&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;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&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>aide.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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="aide_8h.html#87046cda4339ec24652df49eb5fc50c7">Bouton_Aide</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called to open the help window with the keyboard shortcut. <a href="#87046cda4339ec24652df49eb5fc50c7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="aide_8h.html#b20e321c1ca3efa7f839f3fb12d5d496">Bouton_Stats</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Displays and runs the "Statistics" window. <a href="#b20e321c1ca3efa7f839f3fb12d5d496"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="aide_8h.html#728968cff0fc35d4206c08377a5fd094">Fenetre_aide</a> (int Section, const char *Sous_section)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Displays and runs the "Help / About..." window. <a href="#728968cff0fc35d4206c08377a5fd094"></a><br></td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="87046cda4339ec24652df49eb5fc50c7"></a><!-- doxytag: member="aide.h::Bouton_Aide" ref="87046cda4339ec24652df49eb5fc50c7" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bouton_Aide </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Called to open the help window with the keyboard shortcut.
<p>
If the mouse is over a button, its contextual help will be displayed. Else, the default helpscreen will be shown.
<p>References <a class="el" href="aide_8c.html#728968cff0fc35d4206c08377a5fd094">Fenetre_aide()</a>, <a class="el" href="moteur_8c.html#c36e628e69df47d2fea8809e9e912c46">Numero_bouton_sous_souris()</a>, and <a class="el" href="global_8h.html#cad5ab65848f5ae7ccfa2e524e89e808">Touche</a>.</p>
<p>Referenced by <a class="el" href="init_8h.html#8e2cb4e76fcbd7539c90c920665f7c40">Initialisation_des_boutons()</a>.</p>
</div>
</div><p>
<a class="anchor" name="b20e321c1ca3efa7f839f3fb12d5d496"></a><!-- doxytag: member="aide.h::Bouton_Stats" ref="b20e321c1ca3efa7f839f3fb12d5d496" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bouton_Stats </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Displays and runs the "Statistics" window.
<p>
<p>References <a class="el" href="windows_8c.html#b837de751a467219ee4eaa9202c56aef">Afficher_curseur()</a>, <a class="el" href="const_8h.html#c7e01ce6c7c08d8d61e99c2d9dc40280">ALPHA_BETA</a>, <a class="el" href="global_8h.html#201f32339eeb2ebc243d1de04a856924">Block</a>, <a class="el" href="const_8h.html#67ce97fb706063548062aa641d77a7a863f01ddf6c6208bd0df6b15ee6cc363b">BOUTON_AIDE</a>, <a class="el" href="global_8h.html#cd2803f162f85b24ac1c1b2a2c25b6de">CM_Noir</a>, <a class="el" href="moteur_8c.html#ac267eee48246beae2e56d2ef9a8f6d7">Desenclencher_bouton()</a>, <a class="el" href="windows_8c.html#65af6a054f1c5284864bdb55c9ada57d">Fenetre_Afficher_cadre_creux()</a>, <a class="el" href="moteur_8c.html#047d5c4431ce0351abe4b8c098a3bbcb">Fenetre_Bouton_clicke()</a>, <a class="el" href="moteur_8c.html#f31e8028badc61c647613f8049fb75a1">Fenetre_Definir_bouton_normal()</a>, <a class="el" href="global_8h.html#f7514cf38dd0c41f29c21dc4feb39ab0">Fenetre_Pos_X</a>, <a class="el" href="global_8h.html#97b5ab8c3d6a44ff27e0e3a79818c521">Fenetre_Pos_Y</a>, <a class="el" href="moteur_8c.html#c4ec635adfb454496e5069a64abbc761">Fermer_fenetre()</a>, <a class="el" href="global_8h.html#4832486ae2e8cb0da5a1d69287adcd71">Hauteur_ecran</a>, <a class="el" href="global_8h.html#71463060a85d2c31eea4d9a16c535e4c">Largeur_ecran</a>, <a class="el" href="divers_8c.html#c85513adc78f902d5796b70933c64c46">Memoire_libre()</a>, <a class="el" href="global_8h.html#9165b289f849afbe536c42b2583bb636">Menu_Facteur_X</a>, <a class="el" href="global_8h.html#547d90ab81e9c2bdaa524fbe62085fe1">Menu_Facteur_Y</a>, <a class="el" href="moteur_8c.html#c7e9fa465c0448fd846baeffd3cf52ba">Ouvrir_fenetre()</a>, <a class="el" href="divers_8c.html#5f2926ca40b06bae49ccb233ff1208cd">Palette_Compter_nb_couleurs_utilisees()</a>, <a class="el" href="const_8h.html#67ad26412a3a3e5cac9fe27fa7afc075">POURCENTAGE_VERSION</a>, <a class="el" href="global_8h.html#48dd1a1f2a5b757ae37f31afe991f20c">Principal_Hauteur_image</a>, <a class="el" href="global_8h.html#c575dff8dfa9dca914fa23c29a008040">Principal_Largeur_image</a>, <a class="el" href="global_8h.html#fad90cc380eb9639c10d78e1be066ede">Principal_Repertoire_courant</a>, <a class="el" href="windows_8c.html#901f91e4bf32a3cd3fe7f04b1f54a68d">Print_dans_fenetre()</a>, <a class="el" href="aide_8c.html#7c4a124156d6b85388a63ebee4832706">STATS_COULEUR_DONNEES</a>, <a class="el" href="aide_8c.html#3409c83b9a3911a8f343a2a3f3469572">STATS_COULEUR_TITRES</a>, <a class="el" href="texte_8c.html#5773dfe63994efa74f9d52ce2fb72010">Support_TrueType()</a>, <a class="el" href="aide_8c.html#8c725cbf028312b257e5da6d6f0ab47d">SVNRevision</a>, <a class="el" href="global_8h.html#cad5ab65848f5ae7ccfa2e524e89e808">Touche</a>, <a class="el" href="gfxcfg_8c.html#7c1e28643ee8caa6677980fa6bc04fb6">TOUCHE_ESC</a>, and <a class="el" href="sdlscreen_8c.html#d97edc15bf248e23cd935974310e1930">UpdateRect()</a>.</p>
<p>Referenced by <a class="el" href="init_8h.html#8e2cb4e76fcbd7539c90c920665f7c40">Initialisation_des_boutons()</a>.</p>
</div>
</div><p>
<a class="anchor" name="728968cff0fc35d4206c08377a5fd094"></a><!-- doxytag: member="aide.h::Fenetre_aide" ref="728968cff0fc35d4206c08377a5fd094" args="(int Section, const char *Sous_section)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Fenetre_aide </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>Section</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>Sous_section</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Displays and runs the "Help / About..." window.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Section</em>&nbsp;</td><td>Number of the help section page to display (equals the button number the mouse was hovering for the contextual help), -1 for the main help page. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Sous_section</em>&nbsp;</td><td>Help sub-section title (the page will be scrolled so this title is at the top). </td></tr>
</table>
</dl>
<p>References <a class="el" href="aide_8c.html#d30740a7fc5d4c8df8b3e62ed157eb93">Afficher_aide()</a>, <a class="el" href="windows_8c.html#b837de751a467219ee4eaa9202c56aef">Afficher_curseur()</a>, <a class="el" href="divers_8c.html#5bc9ce57e8bd1e013f7fe02c30903d1c">Attendre_fin_de_click()</a>, <a class="el" href="global_8h.html#201f32339eeb2ebc243d1de04a856924">Block</a>, <a class="el" href="const_8h.html#67ce97fb706063548062aa641d77a7a863f01ddf6c6208bd0df6b15ee6cc363b">BOUTON_AIDE</a>, <a class="el" href="moteur_8c.html#de5c1ccb4551ad72235eaef6d1405cab">Calculer_hauteur_curseur_jauge()</a>, <a class="el" href="global_8h.html#cd2803f162f85b24ac1c1b2a2c25b6de">CM_Noir</a>, <a class="el" href="moteur_8c.html#ac267eee48246beae2e56d2ef9a8f6d7">Desenclencher_bouton()</a>, <a class="el" href="global_8h.html#f08933771efee67b152cdb8c1eaa99ba">Effacer_curseur</a>, <a class="el" href="windows_8c.html#65af6a054f1c5284864bdb55c9ada57d">Fenetre_Afficher_cadre_creux()</a>, <a class="el" href="global_8h.html#b180912f9f939ed66c27ee6e39db1647">Fenetre_Attribut2</a>, <a class="el" href="moteur_8c.html#047d5c4431ce0351abe4b8c098a3bbcb">Fenetre_Bouton_clicke()</a>, <a class="el" href="aide_8c.html#84e7f69a55aa8465b98366edda193a42">Fenetre_controle()</a>, <a class="el" href="moteur_8c.html#f31e8028badc61c647613f8049fb75a1">Fenetre_Definir_bouton_normal()</a>, <a class="el" href="moteur_8c.html#82b4c8478ac4838939b920b992e84ec9">Fenetre_Definir_bouton_scroller()</a>, <a class="el" href="moteur_8c.html#8a7d32e05cf5359c65c677bfd16cbc75">Fenetre_Definir_bouton_special()</a>, <a class="el" href="moteur_8c.html#4610eee350bc818d011d82436457d0dd">Fenetre_Dessiner_jauge()</a>, <a class="el" href="global_8h.html#f7514cf38dd0c41f29c21dc4feb39ab0">Fenetre_Pos_X</a>, <a class="el" href="global_8h.html#97b5ab8c3d6a44ff27e0e3a79818c521">Fenetre_Pos_Y</a>, <a class="el" href="moteur_8c.html#c4ec635adfb454496e5069a64abbc761">Fermer_fenetre()</a>, <a class="el" href="global_8h.html#9165b289f849afbe536c42b2583bb636">Menu_Facteur_X</a>, <a class="el" href="global_8h.html#547d90ab81e9c2bdaa524fbe62085fe1">Menu_Facteur_Y</a>, <a class="el" href="global_8h.html#a79f2fc30e391a4b1117daf7fc3f34b3">Mouse_Y</a>, <a class="el" href="structFenetre__Bouton__scroller.html#9a391e88e7b51a83d9a19cf721b2bb33">Fenetre_Bouton_scroller::Nb_elements</a>, <a class="el" href="structSection__d__aide.html#7027a73c090b5194aa9ced5886cb45bb">Section_d_aide::Nombre_de_lignes</a>, <a class="el" href="moteur_8c.html#c7e9fa465c0448fd846baeffd3cf52ba">Ouvrir_fenetre()</a>, <a class="el" href="structFenetre__Bouton__scroller.html#967981dc21471853f8e20da7edeb5ab9">Fenetre_Bouton_scroller::Position</a>, <a class="el" href="global_8h.html#6d6ccd6a32167407649f0409d0524b8e">Position_d_aide_en_cours</a>, <a class="el" href="aide_8c.html#c452bc784befd1d0a6b57835c37c1c9b">Scroller_aide()</a>, <a class="el" href="global_8h.html#2c4cb6eda4edb6f3ae85f2c0c0989074">Section_d_aide_en_cours</a>, <a class="el" href="tables__aide_8h.html#9532b218a02dde828c446e84422aaca9">Table_d_aide</a>, <a class="el" href="global_8h.html#cad5ab65848f5ae7ccfa2e524e89e808">Touche</a>, <a class="el" href="gfxcfg_8c.html#7c1e28643ee8caa6677980fa6bc04fb6">TOUCHE_ESC</a>, <a class="el" href="gfxcfg_8c.html#78fe4672fc80295d06db5721315472c9">TOUCHE_MOUSEWHEELDOWN</a>, <a class="el" href="gfxcfg_8c.html#fcb8d54c86bd18900b2b7479e90e25f1">TOUCHE_MOUSEWHEELUP</a>, and <a class="el" href="sdlscreen_8c.html#d97edc15bf248e23cd935974310e1930">UpdateRect()</a>.</p>
<p>Referenced by <a class="el" href="aide_8h.html#87046cda4339ec24652df49eb5fc50c7">Bouton_Aide()</a>, <a class="el" href="boutons_8h.html#8fb38637fbbb477fd0ee3f6c5d43211c">Bouton_Brush_FX()</a>, <a class="el" href="boutons_8h.html#b396a98ef3179ff56938502ae12236f5">Bouton_Colorize_Menu()</a>, <a class="el" href="boutons_8h.html#b594e6d6abc370ae7e112f06bae9c5d3">Bouton_Copy_page()</a>, <a class="el" href="boutons_8h.html#95335a6d8b752c15e1a903d8b37a13fd">Bouton_Degrades()</a>, <a class="el" href="boutons_8h.html#8bfcd88dac68ce3d2845665e3827c2e7">Bouton_Effets()</a>, <a class="el" href="boutons_8c.html#6c36fe28ca19067adf49b81c9a2a33ad">Bouton_Load_ou_Save()</a>, <a class="el" href="boutons_8h.html#e7ebb9e720d8ef909c2022356432d9e6">Bouton_Menu_Grille()</a>, <a class="el" href="boutons_8h.html#9f5151476bfc49facf295e20c6fb92fb">Bouton_Menu_Loupe()</a>, <a class="el" href="boutons_8h.html#1025cf1c9b1e9740d99089dee8652762">Bouton_Menu_pinceaux()</a>, <a class="el" href="palette_8h.html#113dfd1ae0d38c66d6acb93949efe0eb">Bouton_Palette()</a>, <a class="el" href="palette_8h.html#493f7b4bcddbe23d367cf341af3d95bf">Bouton_Palette_secondaire()</a>, <a class="el" href="shade_8h.html#bef4b429169262aba75e5bf066116628">Bouton_Quick_shade_Menu()</a>, <a class="el" href="boutons_8c.html#ce358802a012dfb059b20a4a19b549d0">Bouton_Quitter_Routine_locale()</a>, <a class="el" href="boutons_8h.html#d4f9a069c7697cb953e1797bb30d80d3">Bouton_Resol()</a>, <a class="el" href="boutons_8h.html#3471661b67c87af0fffbc84a0a6420c0">Bouton_Settings()</a>, <a class="el" href="boutons_8h.html#5635f61f7c0ebe33deea4e8f5c8fdd12">Bouton_Smooth_Menu()</a>, <a class="el" href="boutons_8h.html#2feaf0ebe7cea0c7bb067ef2872c5f7f">Bouton_Spray_Menu()</a>, <a class="el" href="boutons_8h.html#e757e4dda0da044cce84b7e3a98a1cad">Bouton_Texte()</a>, <a class="el" href="boutons_8h.html#93dc13f75cd7b969b1aea2daadaf138d">Bouton_Tiling_Menu()</a>, <a class="el" href="boutons_8h.html#b0fbbf5905dd8504b8b67c56afcd7416">Bouton_Trame_Menu()</a>, <a class="el" href="shade_8c.html#0c3f3929858d89fe9fca3123c5d6365b">Menu_Shade()</a>, and <a class="el" href="boutons_8h.html#cc46fd9487924929e54061bc5c3a21f0">Menu_Tag_couleurs()</a>.</p>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 6 16:43:56 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>