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
2009-03-06 21:05:05 +00:00
parent b5a1fadbe0
commit 5f50f7bc22
310 changed files with 117783 additions and 2 deletions
--- a/doxydoc/html/SDLMain_8m.html
+++ b/doxydoc/html/SDLMain_8m.html
@@ -0,0 +1,346 @@
+<!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: SDLMain.m 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>SDLMain.m File Reference</h1><code>#import &quot;SDL.h&quot;</code><br>
+<code>#import &quot;<a class="el" href="SDLMain_8h.html">SDLMain.h</a>&quot;</code><br>
+<code>#import &lt;sys/param.h&gt;</code><br>
+<code>#import &lt;unistd.h&gt;</code><br>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceNSApplication_07SDL__Missing__Methods_08.html">NSApplication(SDL_Missing_Methods)</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCPSProcessSerNum.html">CPSProcessSerNum</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceSDLApplication.html">SDLApplication</a></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="SDLMain_8m.html#f805d9fa90373cc35df13c37defeff45">SDL_USE_NIB_FILE</a>&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="SDLMain_8m.html#48c21fcb03e0b2b0ff28c87ad54392ef">SDL_USE_CPS</a>&nbsp;&nbsp;&nbsp;1</td></tr>
+
+<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">OSErr&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDLMain_8m.html#d55dee30149aabb9188f2b819124d9b1">CPSGetCurrentProcess</a> (<a class="el" href="structCPSProcessSerNum.html">CPSProcessSerNum</a> *psn)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">OSErr&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDLMain_8m.html#b859ce97083e8063c6b1c1e7c625f82e">CPSEnableForegroundOperation</a> (<a class="el" href="structCPSProcessSerNum.html">CPSProcessSerNum</a> *psn, UInt32 _arg2, UInt32 _arg3, UInt32 _arg4, UInt32 _arg5)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">OSErr&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDLMain_8m.html#255c7afda969f0ecb64546773130f417">CPSSetFrontProcess</a> (<a class="el" href="structCPSProcessSerNum.html">CPSProcessSerNum</a> *psn)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classNSString.html">NSString</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDLMain_8m.html#ca21a1a93d5f76245718a17ca65b4973">getApplicationName</a> (void)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDLMain_8m.html#3c04138a5bfe5d72780bb7e82a18e627">main</a> (int argc, char **argv)</td></tr>
+
+<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDLMain_8m.html#e98bf8c5793e3f98589562d77b7aeadc">gArgc</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">static char **&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDLMain_8m.html#4ab2a0bcf08ca011353b308862d6e554">gArgv</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">static BOOL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDLMain_8m.html#42dfee95a1fb037a71ea7ab1ce157be3">gFinderLaunch</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">static BOOL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDLMain_8m.html#45ef1aede94a85be31ac35fad995e007">gCalledAppMainline</a> = FALSE</td></tr>
+
+</table>
+<hr><h2>Define Documentation</h2>
+<a class="anchor" name="f805d9fa90373cc35df13c37defeff45"></a><!-- doxytag: member="SDLMain.m::SDL_USE_NIB_FILE" ref="f805d9fa90373cc35df13c37defeff45" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define SDL_USE_NIB_FILE&nbsp;&nbsp;&nbsp;0          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="48c21fcb03e0b2b0ff28c87ad54392ef"></a><!-- doxytag: member="SDLMain.m::SDL_USE_CPS" ref="48c21fcb03e0b2b0ff28c87ad54392ef" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define SDL_USE_CPS&nbsp;&nbsp;&nbsp;1          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="d55dee30149aabb9188f2b819124d9b1"></a><!-- doxytag: member="SDLMain.m::CPSGetCurrentProcess" ref="d55dee30149aabb9188f2b819124d9b1" args="(CPSProcessSerNum *psn)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">OSErr CPSGetCurrentProcess           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="structCPSProcessSerNum.html">CPSProcessSerNum</a> *&nbsp;</td>
+          <td class="paramname"> <em>psn</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="b859ce97083e8063c6b1c1e7c625f82e"></a><!-- doxytag: member="SDLMain.m::CPSEnableForegroundOperation" ref="b859ce97083e8063c6b1c1e7c625f82e" args="(CPSProcessSerNum *psn, UInt32 _arg2, UInt32 _arg3, UInt32 _arg4, UInt32 _arg5)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">OSErr CPSEnableForegroundOperation           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="structCPSProcessSerNum.html">CPSProcessSerNum</a> *&nbsp;</td>
+          <td class="paramname"> <em>psn</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">UInt32&nbsp;</td>
+          <td class="paramname"> <em>_arg2</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">UInt32&nbsp;</td>
+          <td class="paramname"> <em>_arg3</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">UInt32&nbsp;</td>
+          <td class="paramname"> <em>_arg4</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">UInt32&nbsp;</td>
+          <td class="paramname"> <em>_arg5</em></td><td>&nbsp;</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="255c7afda969f0ecb64546773130f417"></a><!-- doxytag: member="SDLMain.m::CPSSetFrontProcess" ref="255c7afda969f0ecb64546773130f417" args="(CPSProcessSerNum *psn)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">OSErr CPSSetFrontProcess           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="structCPSProcessSerNum.html">CPSProcessSerNum</a> *&nbsp;</td>
+          <td class="paramname"> <em>psn</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="ca21a1a93d5f76245718a17ca65b4973"></a><!-- doxytag: member="SDLMain.m::getApplicationName" ref="ca21a1a93d5f76245718a17ca65b4973" args="(void)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">static <a class="el" href="classNSString.html">NSString</a>* getApplicationName           </td>
+          <td>(</td>
+          <td class="paramtype">void&nbsp;</td>
+          <td class="paramname">          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [static]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+</div>
+</div><p>
+<a class="anchor" name="3c04138a5bfe5d72780bb7e82a18e627"></a><!-- doxytag: member="SDLMain.m::main" ref="3c04138a5bfe5d72780bb7e82a18e627" args="(int argc, char **argv)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int main           </td>
+          <td>(</td>
+          <td class="paramtype">int&nbsp;</td>
+          <td class="paramname"> <em>argc</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">char **&nbsp;</td>
+          <td class="paramname"> <em>argv</em></td><td>&nbsp;</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="SDLMain_8m.html#e98bf8c5793e3f98589562d77b7aeadc">gArgc</a>, <a class="el" href="SDLMain_8m.html#4ab2a0bcf08ca011353b308862d6e554">gArgv</a>, <a class="el" href="SDLMain_8m.html#42dfee95a1fb037a71ea7ab1ce157be3">gFinderLaunch</a>, <a class="el" href="boutons_8c.html#996bde01ecac342918f0a2c4e7ce7bd5">NO</a>, and <a class="el" href="boutons_8c.html#7ebc9a785e5ab85457c98595aac81589">YES</a>.</p>
+
+</div>
+</div><p>
+<hr><h2>Variable Documentation</h2>
+<a class="anchor" name="e98bf8c5793e3f98589562d77b7aeadc"></a><!-- doxytag: member="SDLMain.m::gArgc" ref="e98bf8c5793e3f98589562d77b7aeadc" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int <a class="el" href="SDLMain_8m.html#e98bf8c5793e3f98589562d77b7aeadc">gArgc</a><code> [static]</code>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Referenced by <a class="el" href="SDLMain_8m.html#3c04138a5bfe5d72780bb7e82a18e627">main()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="4ab2a0bcf08ca011353b308862d6e554"></a><!-- doxytag: member="SDLMain.m::gArgv" ref="4ab2a0bcf08ca011353b308862d6e554" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">char** <a class="el" href="SDLMain_8m.html#4ab2a0bcf08ca011353b308862d6e554">gArgv</a><code> [static]</code>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Referenced by <a class="el" href="SDLMain_8m.html#3c04138a5bfe5d72780bb7e82a18e627">main()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="42dfee95a1fb037a71ea7ab1ce157be3"></a><!-- doxytag: member="SDLMain.m::gFinderLaunch" ref="42dfee95a1fb037a71ea7ab1ce157be3" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">BOOL <a class="el" href="SDLMain_8m.html#42dfee95a1fb037a71ea7ab1ce157be3">gFinderLaunch</a><code> [static]</code>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>Referenced by <a class="el" href="SDLMain_8m.html#3c04138a5bfe5d72780bb7e82a18e627">main()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="45ef1aede94a85be31ac35fad995e007"></a><!-- doxytag: member="SDLMain.m::gCalledAppMainline" ref="45ef1aede94a85be31ac35fad995e007" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">BOOL <a class="el" href="SDLMain_8m.html#45ef1aede94a85be31ac35fad995e007">gCalledAppMainline</a> = FALSE<code> [static]</code>          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<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>