10 Minutes to document your code

peterchen
Rate me:
4.91/5 (155 votes)
19 Jan 2003CPOL13 min read
1.1M
6.9K
397
Setting up doxygen, a free tool to document your code, in a few simple steps.
doxytools.zip
- default.doxygen
- default2.doxygen
- doxygen.dsm
- doxygen_default.css
- doxygen_footer.html
- doxygen_header.html
- sample
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML><HEAD><TITLE>SNAPINFO struct Reference</TITLE>
<META http-equiv=Content-Type content=text/html;charset=iso-8859-1><LINK 
href="SNAPINFO_org_files/doxygen.css" type=text/css rel=stylesheet>
<META content="MSHTML 6.00.2715.400" name=GENERATOR></HEAD>
<BODY><!-- Generated by Doxygen 1.3-rc2 -->
<CENTER><A class=qindex 
href="file:///E:/C/pub/mdisnap/project/doxydoc/index.html">Main Page</A> &nbsp; 
<A class=qindex 
href="file:///E:/C/pub/mdisnap/project/doxydoc/classes.html">Alphabetical 
List</A> &nbsp; <A class=qindex 
href="file:///E:/C/pub/mdisnap/project/doxydoc/annotated.html">Data 
Structures</A> &nbsp; <A class=qindex 
href="file:///E:/C/pub/mdisnap/project/doxydoc/files.html">File List</A> &nbsp; 
<A class=qindex 
href="file:///E:/C/pub/mdisnap/project/doxydoc/functions.html">Data Fields</A> 
&nbsp; <A class=qindex 
href="file:///E:/C/pub/mdisnap/project/doxydoc/globals.html">Globals</A> &nbsp; 
</CENTER>
<HR>

<H1>SNAPINFO Struct Reference</H1><CODE>#include &lt;<A class=el 
href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8h-source.html">MDISnapper.h</A>&gt;</CODE> 

<P>
<TABLE cellSpacing=0 cellPadding=0 border=0>
  <TBODY>
  <TR>
    <TD></TD></TR>
  <TR>
    <TD colSpan=2><BR>
      <H2>Public Types</H2></TD></TR>
  <TR>
    <TD vAlign=top noWrap align=right>enum &nbsp;</TD>
    <TD vAlign=bottom>{ <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/structSNAPINFO.html#s1s0">MAXDELTA</A> 
      = (1&lt;&lt;30) }</TD></TR>
  <TR>
    <TD colSpan=2><BR>
      <H2>Public Methods</H2></TD></TR>
  <TR>
    <TD vAlign=top noWrap align=right>void&nbsp;</TD>
    <TD vAlign=bottom><A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/structSNAPINFO.html#a0">Init</A> 
      (RECT const &amp;oldRect, RECT const &amp;newRect, DWORD snapwidth)</TD></TR>
  <TR>
    <TD vAlign=top noWrap align=right>void&nbsp;</TD>
    <TD vAlign=bottom><A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/structSNAPINFO.html#a1">Init</A> 
      (RECT const &amp;r, DWORD <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/structSNAPINFO.html#m0">snapWidth</A>, 
      bool moveOnly=false)</TD></TR>
  <TR>
    <TD vAlign=top noWrap align=right>void&nbsp;</TD>
    <TD vAlign=bottom><A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/structSNAPINFO.html#a2">SnapHLine</A> 
      (long y)</TD></TR>
  <TR>
    <TD vAlign=top noWrap align=right>void&nbsp;</TD>
    <TD vAlign=bottom><A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/structSNAPINFO.html#a3">SnapVLine</A> 
      (long x)</TD></TR>
  <TR>
    <TD vAlign=top noWrap align=right>RECT &amp;&nbsp;</TD>
    <TD vAlign=bottom><A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/structSNAPINFO.html#a4">EndSnap</A> 
      ()</TD></TR>
  <TR>
    <TD colSpan=2><BR>
      <H2>Data Fields</H2></TD></TR>
  <TR>
    <TD vAlign=top noWrap align=right>DWORD&nbsp;</TD>
    <TD vAlign=bottom><A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/structSNAPINFO.html#m0">snapWidth</A></TD></TR>
  <TR>
    <TD vAlign=top noWrap align=right>RECT&nbsp;</TD>
    <TD vAlign=bottom><A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/structSNAPINFO.html#m1">rold</A></TD></TR>
  <TR>
    <TD vAlign=top noWrap align=right>RECT&nbsp;</TD>
    <TD vAlign=bottom><A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/structSNAPINFO.html#m2">rnew</A></TD></TR>
  <TR>
    <TD vAlign=top noWrap align=right>RECT&nbsp;</TD>
    <TD vAlign=bottom><A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/structSNAPINFO.html#m3">rdelta</A></TD></TR>
  <TR>
    <TD vAlign=top noWrap align=right>RECT&nbsp;</TD>
    <TD vAlign=bottom><A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/structSNAPINFO.html#m4">rout</A></TD></TR></TBODY></TABLE>
<HR>

<H2>Member Enumeration Documentation</H2><A name=s1 doxytag="SNAPINFO::@0"></A>
<P>
<TABLE cellSpacing=0 cellPadding=2 width="100%" border=0>
  <TBODY>
  <TR>
    <TD class=md>
      <TABLE cellSpacing=0 cellPadding=0 border=0>
        <TBODY>
        <TR>
          <TD class=md vAlign=top noWrap>anonymous enum 
  </TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
<TABLE cellSpacing=5 cellPadding=0 border=0>
  <TBODY>
  <TR>
    <TD>&nbsp; </TD>
    <TD>
      <P>
      <DL compact>
        <DT><B>Enumeration values: </B>
        <DD>
        <TABLE cellSpacing=2 cellPadding=0 border=0>
          <TBODY>
          <TR>
            <TD vAlign=top><EM><A name=s1s0 
              doxytag="MAXDELTA"></A><EM>MAXDELTA</EM></EM>&nbsp;</TD>
            <TD></TD></TR></TBODY></TABLE></DD></DL>
      <P>Definition at line <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8h-source.html#l00015">15</A> 
      of file <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8h-source.html">MDISnapper.h</A>. 
      </P></TD></TR></TBODY></TABLE>
<HR>

<H2>Member Function Documentation</H2><A name=a0 doxytag="SNAPINFO::Init"></A>
<P>
<TABLE cellSpacing=0 cellPadding=2 width="100%" border=0>
  <TBODY>
  <TR>
    <TD class=md>
      <TABLE cellSpacing=0 cellPadding=0 border=0>
        <TBODY>
        <TR>
          <TD class=md vAlign=top noWrap>void SNAPINFO::Init </TD>
          <TD class=md vAlign=top>(&nbsp;</TD>
          <TD class=md vAlign=top noWrap>RECT const &amp;&nbsp;</TD>
          <TD class=mdname noWrap>&nbsp; <EM>oldRect</EM>, </TD></TR>
        <TR>
          <TD></TD>
          <TD></TD>
          <TD class=md noWrap>RECT const &amp;&nbsp;</TD>
          <TD class=mdname noWrap>&nbsp; <EM>newRect</EM>, </TD></TR>
        <TR>
          <TD></TD>
          <TD></TD>
          <TD class=md noWrap>DWORD&nbsp;</TD>
          <TD class=mdname noWrap>&nbsp; <EM>snapwidth</EM></TD></TR>
        <TR>
          <TD></TD>
          <TD class=md>)&nbsp;</TD>
          <TD class=md colSpan=2></TD></TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
<TABLE cellSpacing=5 cellPadding=0 border=0>
  <TBODY>
  <TR>
    <TD>&nbsp; </TD>
    <TD>
      <P>
      <P>Definition at line <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8cpp-source.html#l00035">35</A> 
      of file <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8cpp-source.html">MDISnapper.cpp</A>. 
      </P></TD></TR></TBODY></TABLE><A name=a1 doxytag="SNAPINFO::Init"></A>
<P>
<TABLE cellSpacing=0 cellPadding=2 width="100%" border=0>
  <TBODY>
  <TR>
    <TD class=md>
      <TABLE cellSpacing=0 cellPadding=0 border=0>
        <TBODY>
        <TR>
          <TD class=md vAlign=top noWrap>void SNAPINFO::Init </TD>
          <TD class=md vAlign=top>(&nbsp;</TD>
          <TD class=md vAlign=top noWrap>RECT const &amp;&nbsp;</TD>
          <TD class=mdname noWrap>&nbsp; <EM>r</EM>, </TD></TR>
        <TR>
          <TD></TD>
          <TD></TD>
          <TD class=md noWrap>DWORD&nbsp;</TD>
          <TD class=mdname noWrap>&nbsp; <EM>snapWidth</EM>, </TD></TR>
        <TR>
          <TD></TD>
          <TD></TD>
          <TD class=md noWrap>bool&nbsp;</TD>
          <TD class=mdname noWrap>&nbsp; <EM>moveOnly</EM> = false</TD></TR>
        <TR>
          <TD></TD>
          <TD class=md>)&nbsp;</TD>
          <TD class=md colSpan=2></TD></TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
<TABLE cellSpacing=5 cellPadding=0 border=0>
  <TBODY>
  <TR>
    <TD>&nbsp; </TD>
    <TD>
      <P>
      <P>Definition at line <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8cpp-source.html#l00058">58</A> 
      of file <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8cpp-source.html">MDISnapper.cpp</A>. 
      </P></TD></TR></TBODY></TABLE><A name=a2 doxytag="SNAPINFO::SnapHLine"></A>
<P>
<TABLE cellSpacing=0 cellPadding=2 width="100%" border=0>
  <TBODY>
  <TR>
    <TD class=md>
      <TABLE cellSpacing=0 cellPadding=0 border=0>
        <TBODY>
        <TR>
          <TD class=md vAlign=top noWrap>void SNAPINFO::SnapHLine </TD>
          <TD class=md vAlign=top>(&nbsp;</TD>
          <TD class=md vAlign=top noWrap>long&nbsp;</TD>
          <TD class=mdname1 vAlign=top noWrap>&nbsp; <EM>y</EM> </TD>
          <TD class=md vAlign=top>)&nbsp;</TD>
          <TD class=md noWrap></TD></TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
<TABLE cellSpacing=5 cellPadding=0 border=0>
  <TBODY>
  <TR>
    <TD>&nbsp; </TD>
    <TD>
      <P>
      <P>Definition at line <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8cpp-source.html#l00111">111</A> 
      of file <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8cpp-source.html">MDISnapper.cpp</A>. 
      </P></TD></TR></TBODY></TABLE><A name=a3 doxytag="SNAPINFO::SnapVLine"></A>
<P>
<TABLE cellSpacing=0 cellPadding=2 width="100%" border=0>
  <TBODY>
  <TR>
    <TD class=md>
      <TABLE cellSpacing=0 cellPadding=0 border=0>
        <TBODY>
        <TR>
          <TD class=md vAlign=top noWrap>void SNAPINFO::SnapVLine </TD>
          <TD class=md vAlign=top>(&nbsp;</TD>
          <TD class=md vAlign=top noWrap>long&nbsp;</TD>
          <TD class=mdname1 vAlign=top noWrap>&nbsp; <EM>x</EM> </TD>
          <TD class=md vAlign=top>)&nbsp;</TD>
          <TD class=md noWrap></TD></TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
<TABLE cellSpacing=5 cellPadding=0 border=0>
  <TBODY>
  <TR>
    <TD>&nbsp; </TD>
    <TD>
      <P>
      <P>Definition at line <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8cpp-source.html#l00074">74</A> 
      of file <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8cpp-source.html">MDISnapper.cpp</A>. 
      </P></TD></TR></TBODY></TABLE><A name=a4 doxytag="SNAPINFO::EndSnap"></A>
<P>
<TABLE cellSpacing=0 cellPadding=2 width="100%" border=0>
  <TBODY>
  <TR>
    <TD class=md>
      <TABLE cellSpacing=0 cellPadding=0 border=0>
        <TBODY>
        <TR>
          <TD class=md vAlign=top noWrap>RECT &amp; SNAPINFO::EndSnap </TD>
          <TD class=md vAlign=top>(&nbsp;</TD>
          <TD class=mdname1 vAlign=top noWrap>&nbsp; </TD>
          <TD class=md vAlign=top>)&nbsp;</TD>
          <TD class=md noWrap></TD></TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
<TABLE cellSpacing=5 cellPadding=0 border=0>
  <TBODY>
  <TR>
    <TD>&nbsp; </TD>
    <TD>
      <P>
      <P>Definition at line <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8cpp-source.html#l00150">150</A> 
      of file <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8cpp-source.html">MDISnapper.cpp</A>. 
      </P></TD></TR></TBODY></TABLE>
<HR>

<H2>Field Documentation</H2><A name=m0 doxytag="SNAPINFO::snapWidth"></A>
<P>
<TABLE cellSpacing=0 cellPadding=2 width="100%" border=0>
  <TBODY>
  <TR>
    <TD class=md>
      <TABLE cellSpacing=0 cellPadding=0 border=0>
        <TBODY>
        <TR>
          <TD class=md vAlign=top noWrap>DWORD SNAPINFO::snapWidth 
      </TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
<TABLE cellSpacing=5 cellPadding=0 border=0>
  <TBODY>
  <TR>
    <TD>&nbsp; </TD>
    <TD>
      <P>
      <P>Definition at line <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8h-source.html#l00017">17</A> 
      of file <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8h-source.html">MDISnapper.h</A>. 
      </P></TD></TR></TBODY></TABLE><A name=m1 doxytag="SNAPINFO::rold"></A>
<P>
<TABLE cellSpacing=0 cellPadding=2 width="100%" border=0>
  <TBODY>
  <TR>
    <TD class=md>
      <TABLE cellSpacing=0 cellPadding=0 border=0>
        <TBODY>
        <TR>
          <TD class=md vAlign=top noWrap>RECT SNAPINFO::rold 
  </TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
<TABLE cellSpacing=5 cellPadding=0 border=0>
  <TBODY>
  <TR>
    <TD>&nbsp; </TD>
    <TD>
      <P>
      <P>Definition at line <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8h-source.html#l00019">19</A> 
      of file <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8h-source.html">MDISnapper.h</A>. 
      </P></TD></TR></TBODY></TABLE><A name=m2 doxytag="SNAPINFO::rnew"></A>
<P>
<TABLE cellSpacing=0 cellPadding=2 width="100%" border=0>
  <TBODY>
  <TR>
    <TD class=md>
      <TABLE cellSpacing=0 cellPadding=0 border=0>
        <TBODY>
        <TR>
          <TD class=md vAlign=top noWrap>RECT SNAPINFO::rnew 
  </TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
<TABLE cellSpacing=5 cellPadding=0 border=0>
  <TBODY>
  <TR>
    <TD>&nbsp; </TD>
    <TD>
      <P>
      <P>Definition at line <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8h-source.html#l00020">20</A> 
      of file <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8h-source.html">MDISnapper.h</A>. 
      </P></TD></TR></TBODY></TABLE><A name=m3 doxytag="SNAPINFO::rdelta"></A>
<P>
<TABLE cellSpacing=0 cellPadding=2 width="100%" border=0>
  <TBODY>
  <TR>
    <TD class=md>
      <TABLE cellSpacing=0 cellPadding=0 border=0>
        <TBODY>
        <TR>
          <TD class=md vAlign=top noWrap>RECT SNAPINFO::rdelta 
    </TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
<TABLE cellSpacing=5 cellPadding=0 border=0>
  <TBODY>
  <TR>
    <TD>&nbsp; </TD>
    <TD>
      <P>
      <P>Definition at line <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8h-source.html#l00021">21</A> 
      of file <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8h-source.html">MDISnapper.h</A>. 
      </P></TD></TR></TBODY></TABLE><A name=m4 doxytag="SNAPINFO::rout"></A>
<P>
<TABLE cellSpacing=0 cellPadding=2 width="100%" border=0>
  <TBODY>
  <TR>
    <TD class=md>
      <TABLE cellSpacing=0 cellPadding=0 border=0>
        <TBODY>
        <TR>
          <TD class=md vAlign=top noWrap>RECT SNAPINFO::rout 
  </TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
<TABLE cellSpacing=5 cellPadding=0 border=0>
  <TBODY>
  <TR>
    <TD>&nbsp; </TD>
    <TD>
      <P>
      <P>Definition at line <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8h-source.html#l00023">23</A> 
      of file <A class=el 
      href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8h-source.html">MDISnapper.h</A>. 
      </P></TD></TR></TBODY></TABLE>
<HR>
The documentation for this struct was generated from the following files:
<UL>
  <LI><A class=el 
  href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8h-source.html">MDISnapper.h</A>
  <LI><A class=el 
  href="file:///E:/C/pub/mdisnap/project/doxydoc/MDISnapper_8cpp-source.html">MDISnapper.cpp</A></LI></UL>
<HR>

<ADDRESS style="align: right"><SMALL>Generated on Sat Jan 18 21:01:46 2003 for 
***PROJECTNAME*** by <A href="http://www.doxygen.org/index.html"><IMG height=53 
alt=doxygen src="SNAPINFO_org_files/doxygen.png" width=110 align=middle 
border=0></A>1.3-rc2 </SMALL></ADDRESS></BODY></HTML>
By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.
If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.
License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)
Written By
peterchen
Klippel
Germany
Peter is tired of being called "Mr. Chen", even so certain individuals insist on it. No, he's not chinese.

Peter has seen lots of boxes you youngsters wouldn't even accept as calculators. He is proud of having visited the insides of a 16 Bit Machine.

In his spare time he ponders new ways of turning groceries into biohazards, or tries to coax South American officials to add some stamps to his passport.

Beyond these trivialities Peter works for Klippel[^], a small german company that wants to make mankind happier by selling them novel loudspeaker measurement equipment.

Where are you from?[^]
Please, if you are using one of my articles for anything, just leave me a comment. Seeing that this stuff is actually useful to someone is what keeps me posting and updating them.
Should you happen to not like it, tell me, too
10 Minutes to document your code

License

Comments and Discussions
