Doxygen Code Documentation

[Derek Atkins]

Hi,

Matt Graham <matt_graham2001 at hotmail.com> writes:

> G’day all!
>
>
> Whilst there is lot of enthusiasm about documentation flowing around,
> I thought I’d ask a general question regarding the last type of
> documentation not previously mentioned: The doxygen generated
> documentation about how the code works (can I call it the API?).

Sure, you can call it an API, although we make no guarantees on it's
stability :)

> I’ve been taking my time learning and setting up git whilst browsing
> through doxygen and code - specifically around budgets. What I am
> finding is that the level of documentation generated varies greatly
> from file to file (and even within a file).  I generate the
> documentation myself from my clone of the repository.
>
>
> I’m very much a noob (have mainly worked with java in the past, and
> never with anything like gtk) - I am currently have to go line by line
> in the code to figure out specifically what a lot of the methods do,
> and how they all relate to each other to achieve the end goal. Is this
> usual, or is this an area where I can (and should) help out by
> submitting a bug report and developing a patch?

Absolutely!  Improved Doxygen documentation is definitely a good thing!

> Keep up the good work all!
>
> Matt Graham

-derek

-- 
       Derek Atkins, SB '93 MIT EE, SM '95 MIT Media Laboratory
       Member, MIT Student Information Processing Board  (SIPB)
       URL: http://web.mit.edu/warlord/    PP-ASEL-IA     N1NWH
       warlord at MIT.EDU                        PGP key available