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,267 @@
<!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: mountlist.c 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>mountlist.c File Reference</h1><code>#include &quot;<a class="el" href="mountlist_8h.html">mountlist.h</a>&quot;</code><br>
<code>#include &lt;limits.h&gt;</code><br>
<code>#include &lt;stdio.h&gt;</code><br>
<code>#include &lt;stdlib.h&gt;</code><br>
<code>#include &lt;string.h&gt;</code><br>
<code>#include &lt;errno.h&gt;</code><br>
<code>#include &lt;fcntl.h&gt;</code><br>
<code>#include &lt;unistd.h&gt;</code><br>
<code>#include &lt;mntent.h&gt;</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mountlist_8c.html#573c756376d414a725f4f7ddb593da31">MOUNTED_GETMNTENT1</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mountlist_8c.html#ec3f48fd5f3dd45a2202f7196635b95b">MNT_IGNORE</a>(M)&nbsp;&nbsp;&nbsp;0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mountlist_8c.html#3c75bb398badb69c7577b21486f9963f">SIZE_MAX</a>&nbsp;&nbsp;&nbsp;((size_t) -1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mountlist_8c.html#204df010573929d154b7dff7543b7b7e">ME_DUMMY</a>(Fs_name, Fs_type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mountlist_8c.html#8f6e4f7439b2993b9eb0caed0cba2db6">ME_REMOTE</a>(Fs_name, Fs_type)</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static dev_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mountlist_8c.html#0d1d7e7692d75b5c1f5878936e767c7b">dev_from_mount_options</a> (char const *mount_options)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structmount__entry.html">mount_entry</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="mountlist_8c.html#5136f6f12dab78daf741fdcd66d4c1d2">read_file_system_list</a> (bool need_fs_type)</td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="573c756376d414a725f4f7ddb593da31"></a><!-- doxytag: member="mountlist.c::MOUNTED_GETMNTENT1" ref="573c756376d414a725f4f7ddb593da31" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MOUNTED_GETMNTENT1 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ec3f48fd5f3dd45a2202f7196635b95b"></a><!-- doxytag: member="mountlist.c::MNT_IGNORE" ref="ec3f48fd5f3dd45a2202f7196635b95b" args="(M)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MNT_IGNORE </td>
<td>(</td>
<td class="paramtype">M&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;0</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="mountlist_8h.html#5136f6f12dab78daf741fdcd66d4c1d2">read_file_system_list()</a>.</p>
</div>
</div><p>
<a class="anchor" name="3c75bb398badb69c7577b21486f9963f"></a><!-- doxytag: member="mountlist.c::SIZE_MAX" ref="3c75bb398badb69c7577b21486f9963f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SIZE_MAX&nbsp;&nbsp;&nbsp;((size_t) -1) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="mountlist_8h.html#5136f6f12dab78daf741fdcd66d4c1d2">read_file_system_list()</a>.</p>
</div>
</div><p>
<a class="anchor" name="204df010573929d154b7dff7543b7b7e"></a><!-- doxytag: member="mountlist.c::ME_DUMMY" ref="204df010573929d154b7dff7543b7b7e" args="(Fs_name, Fs_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ME_DUMMY </td>
<td>(</td>
<td class="paramtype">Fs_name, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Fs_type&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment">(strcmp (Fs_type, <span class="stringliteral">"autofs"</span>) == 0 \
|| strcmp (Fs_type, <span class="stringliteral">"none"</span>) == 0 \
|| strcmp (Fs_type, <span class="stringliteral">"proc"</span>) == 0 \
|| strcmp (Fs_type, <span class="stringliteral">"subfs"</span>) == 0 \
|| strcmp (Fs_type, <span class="stringliteral">"sysfs"</span>) == 0 \
|| strcmp (Fs_type, <span class="stringliteral">"usbfs"</span>) == 0 \
|| strcmp (Fs_type, <span class="stringliteral">"devpts"</span>) == 0 \
|| strcmp (Fs_type, <span class="stringliteral">"tmpfs"</span>) == 0 \
<span class="comment">/* for NetBSD 3.0 */</span> \
|| strcmp (Fs_type, <span class="stringliteral">"kernfs"</span>) == 0 \
<span class="comment">/* for Irix 6.5 */</span> \
|| strcmp (Fs_type, <span class="stringliteral">"ignore"</span>) == 0)
</pre></div>
<p>Referenced by <a class="el" href="mountlist_8h.html#5136f6f12dab78daf741fdcd66d4c1d2">read_file_system_list()</a>.</p>
</div>
</div><p>
<a class="anchor" name="8f6e4f7439b2993b9eb0caed0cba2db6"></a><!-- doxytag: member="mountlist.c::ME_REMOTE" ref="8f6e4f7439b2993b9eb0caed0cba2db6" args="(Fs_name, Fs_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ME_REMOTE </td>
<td>(</td>
<td class="paramtype">Fs_name, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Fs_type&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>Value:</b><div class="fragment"><pre class="fragment">(strchr (Fs_name, <span class="charliteral">':'</span>) != NULL \
|| ((Fs_name)[0] == <span class="charliteral">'/'</span> \
&amp;&amp; (Fs_name)[1] == <span class="charliteral">'/'</span> \
&amp;&amp; (strcmp (Fs_type, <span class="stringliteral">"smbfs"</span>) == 0 \
|| strcmp (Fs_type, <span class="stringliteral">"cifs"</span>) == 0)))
</pre></div>
<p>Referenced by <a class="el" href="mountlist_8h.html#5136f6f12dab78daf741fdcd66d4c1d2">read_file_system_list()</a>.</p>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="0d1d7e7692d75b5c1f5878936e767c7b"></a><!-- doxytag: member="mountlist.c::dev_from_mount_options" ref="0d1d7e7692d75b5c1f5878936e767c7b" args="(char const *mount_options)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static dev_t dev_from_mount_options </td>
<td>(</td>
<td class="paramtype">char const *&nbsp;</td>
<td class="paramname"> <em>mount_options</em> </td>
<td>&nbsp;)&nbsp;</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="mountlist_8h.html#5136f6f12dab78daf741fdcd66d4c1d2">read_file_system_list()</a>.</p>
</div>
</div><p>
<a class="anchor" name="5136f6f12dab78daf741fdcd66d4c1d2"></a><!-- doxytag: member="mountlist.c::read_file_system_list" ref="5136f6f12dab78daf741fdcd66d4c1d2" args="(bool need_fs_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structmount__entry.html">mount_entry</a>* read_file_system_list </td>
<td>(</td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>need_fs_type</em> </td>
<td>&nbsp;)&nbsp;</td>
<td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="mountlist_8c.html#0d1d7e7692d75b5c1f5878936e767c7b">dev_from_mount_options()</a>, <a class="el" href="structmount__entry.html#a6e7043a568c935dc5ca9a17fba77bbc">mount_entry::me_dev</a>, <a class="el" href="structmount__entry.html#03f9dec6b5f2a7c6f024e210289d5ebb">mount_entry::me_devname</a>, <a class="el" href="mountlist_8c.html#204df010573929d154b7dff7543b7b7e">ME_DUMMY</a>, <a class="el" href="structmount__entry.html#d9e244dc90796fccd25a3dc2e99f5df4">mount_entry::me_dummy</a>, <a class="el" href="structmount__entry.html#646bbb85f70e7cd0d6a37b4bfce91d4a">mount_entry::me_mountdir</a>, <a class="el" href="structmount__entry.html#0936ded635c80ff3995ffc55a2515e51">mount_entry::me_next</a>, <a class="el" href="mountlist_8c.html#8f6e4f7439b2993b9eb0caed0cba2db6">ME_REMOTE</a>, <a class="el" href="structmount__entry.html#cb0f555c15f8837c301027026031073e">mount_entry::me_remote</a>, <a class="el" href="structmount__entry.html#f665ef2d1e0a9ce6e5106dd4ad67ea37">mount_entry::me_type</a>, <a class="el" href="structmount__entry.html#f026e39430cf4ba771035e7ae942ea6d">mount_entry::me_type_malloced</a>, <a class="el" href="mountlist_8c.html#ec3f48fd5f3dd45a2202f7196635b95b">MNT_IGNORE</a>, and <a class="el" href="mountlist_8c.html#3c75bb398badb69c7577b21486f9963f">SIZE_MAX</a>.</p>
<p>Referenced by <a class="el" href="files_8h.html#619bf3e335546f1fe9898a2f2df3dd40">Lire_liste_des_lecteurs()</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&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>