cvs commit: src Makefile.inc1 ObsoleteFiles.inc src/etc/defaults rc.conf

[Alexander Leidinger]

Quoting Sergey Babkin <babkin at verizon.net> (from Fri, 19 May 2006  
06:14:58 -0500 (CDT)):

> Doxygen is definitely beffer than nothing but not a
> replacement for proper man pages either. I've had
> experience with this kind of documentation in Qt,
> and it gives some idea of what is happening inside
> the function but always leaves enough mystery.
> The part that is missing is the big picture of how
> these functions are intended to work together.

You can add some introduction, e.g. by using a separate file and  
instructing doxygen to read it, which contains the big picture.

Bye,
Alexander.

-- 
http://www.Leidinger.net  Alexander @ Leidinger.net: PGP ID = B0063FE7
http://www.FreeBSD.org     netchild @ FreeBSD.org  : PGP ID = 72077137
It is easier to write an incorrect program than understand a correct one.