<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>RedBrain @ $HOME : ~ $ &#187; doxygen</title>
	<atom:link href="http://redbrain.co.uk/index.php/tag/doxygen/feed/" rel="self" type="application/rss+xml" />
	<link>http://redbrain.co.uk</link>
	<description>Frustrated Software Developer</description>
	<lastBuildDate>Wed, 16 Nov 2011 17:36:07 +0000</lastBuildDate>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.2.1</generator>
		<item>
		<title>Doxygen &#8211; Sweet :D</title>
		<link>http://redbrain.co.uk/index.php/quick-tips/doxygen-sweet-d/</link>
		<comments>http://redbrain.co.uk/index.php/quick-tips/doxygen-sweet-d/#comments</comments>
		<pubDate>Wed, 18 Mar 2009 11:26:34 +0000</pubDate>
		<dc:creator>redbrain</dc:creator>
				<category><![CDATA[Quick Tips]]></category>
		<category><![CDATA[Tutorials]]></category>
		<category><![CDATA[Update!]]></category>
		<category><![CDATA[c/c++]]></category>
		<category><![CDATA[doxygen]]></category>
		<category><![CDATA[emacs]]></category>
		<category><![CDATA[linux]]></category>
		<category><![CDATA[Programming]]></category>

		<guid isPermaLink="false">http://redbrain.co.uk/?p=333</guid>
		<description><![CDATA[<p>This is pretty amazing i think take a look at some Doxygen output:
</p>
<p>I think its really worth learning + it will save you about a week or 2&#8242;s worth of documentation:</p>
<p>What you want to do is go to your projects directory and:</p>
<p>$ sudo apt-get install doxygen</p>
<p>$ doxygen -g</p>
<p>$ emacs -nw Doxyfile</p>
<p>$ echo &#8220;Now go through [...]]]></description>
			<content:encoded><![CDATA[<p>This is pretty amazing i think take a look at some Doxygen output:<br />
</p>
<p>I think its really worth learning + it will save you about a week or 2&#8242;s worth of documentation:</p>
<p>What you want to do is go to your projects directory and:</p>
<blockquote><p>$ sudo apt-get install doxygen</p></blockquote>
<blockquote><p>$ doxygen -g</p></blockquote>
<blockquote><p>$ emacs -nw Doxyfile</p>
<p>$ echo &#8220;Now go through each of these options in the config file use CTRL-S to start searching in emacs <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_wink.gif' alt=';)' class='wp-smiley' /> &#8221;</p></blockquote>
<blockquote>
<blockquote><dl> </dl>
</blockquote>
<dt><code>EXTRACT_ALL = YES</code></dt>
</blockquote>
<blockquote><dd>Extract documentation even from those elements you haven&#8217;t yet commented.</dd>
</blockquote>
<blockquote><dt><code>INLINE_SOURCE = YES</code></dt>
</blockquote>
<blockquote><dd>Extract the relevant parts of the source and associate them with your description.</dd>
</blockquote>
<blockquote><dt><code>HAVE_DOT = YES</code></dt>
</blockquote>
<blockquote><dd>Use Graphviz for class and collaboration diagrams.</dd>
</blockquote>
<blockquote><dt><code>CALL_GRAPH = YES</code></dt>
</blockquote>
<blockquote><dd>Generate a dependency graph for functions and methods.</dd>
</blockquote>
<blockquote><dt><code>GENERATE_LATEX = NO</code></dt>
</blockquote>
<blockquote><dd>Skip generating <code>LaTeX</code> sources for <code>PDF</code>.</dd>
</blockquote>
<blockquote><p>RECURSIVE              = YES</p></blockquote>
<blockquote><p>To go through each of your directorys! Probably the most important.</p></blockquote>
<blockquote><p>FILE_PATTERNS          = *.c *.h</p>
<p>The source files you want to document!</p></blockquote>
<blockquote><p>echo &#8220;Now run&#8221;</p></blockquote>
<blockquote><p>$ doxygen Doxyfile</p></blockquote>
<blockquote><p>#Hope it works <img src='http://redbrain.co.uk/wp-includes/images/smilies/icon_biggrin.gif' alt=':D' class='wp-smiley' /> </p></blockquote>
<p>Finally to do documentation you need to go to your code and do documenation like:</p>
<div class="dean_ch" style="white-space: wrap;">
<ol>
<li class="li1">
<div class="de1"><span class="coMULTI">/**</span></div>
</li>
<li class="li1">
<div class="de1"><span class="coMULTI">&nbsp;* Return the size of the list.</span></div>
</li>
<li class="li1">
<div class="de1"><span class="coMULTI">&nbsp;*</span></div>
</li>
<li class="li1">
<div class="de1"><span class="coMULTI">&nbsp;* \return returns the size of the list as an int</span></div>
</li>
<li class="li2">
<div class="de2"><span class="coMULTI">&nbsp;* \param list The List you want to add the item to</span></div>
</li>
<li class="li1">
<div class="de1"><span class="coMULTI">&nbsp;*/</span></div>
</li>
<li class="li1">
<div class="de1"><span class="kw2">extern</span> <span class="kw4">int</span> size<span class="br0">&#40;</span> LinkedList** list<span class="br0">&#41;</span> <span class="br0">&#123;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw4">int</span> counter=<span class="nu0">0</span>;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; LinkedList *tmp=*list;</div>
</li>
<li class="li2">
<div class="de2">&nbsp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="kw1">if</span><span class="br0">&#40;</span>tmp-&gt;contents != <span class="kw2">NULL</span><span class="br0">&#41;</span> <span class="br0">&#123;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="kw4">struct</span> ListNode *next= tmp;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; counter++;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="kw1">while</span><span class="br0">&#40;</span>next-&gt;nextnode != <span class="kw2">NULL</span><span class="br0">&#41;</span><span class="br0">&#123;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; &nbsp; &nbsp; next= next-&gt;nextnode;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; &nbsp; counter++;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="br0">&#125;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="kw1">return</span> counter;</div>
</li>
<li class="li1">
<div class="de1">&nbsp; <span class="br0">&#125;</span></div>
</li>
<li class="li2">
<div class="de2">&nbsp; <span class="kw1">else</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp; &nbsp; <span class="kw1">return</span> counter;</div>
</li>
<li class="li1">
<div class="de1"><span class="br0">&#125;</span></div>
</li>
<li class="li1">
<div class="de1">&nbsp;</div>
</li>
</ol>
</div>
]]></content:encoded>
			<wfw:commentRss>http://redbrain.co.uk/index.php/quick-tips/doxygen-sweet-d/feed/</wfw:commentRss>
		<slash:comments>1</slash:comments>
		</item>
	</channel>
</rss>

