Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 19 May 2006 15:16:24 +0200
From:      Alexander Leidinger <Alexander@Leidinger.net>
To:        babkin@users.sourceforge.net, Sergey Babkin <babkin@verizon.net>
Cc:        src-committers@FreeBSD.org, cvs-src@FreeBSD.org, gnn@neville-neil.com, cvs-all@FreeBSD.org, phk@phk.freebsd.dk, julian@elischer.org, hellmuth.michaelis@t-online.de, Warner Losh <imp@bsdimp.com>
Subject:   Re: Re: cvs commit: src Makefile.inc1 ObsoleteFiles.inc src/etc/defaults rc.conf
Message-ID:  <20060519151624.sd392gz3swcc8800@netchild.homeip.net>
In-Reply-To: <16489295.8854801148037298444.JavaMail.root@vms168.mailsrvcs.net>
References:  <16489295.8854801148037298444.JavaMail.root@vms168.mailsrvcs.net>

next in thread | previous in thread | raw e-mail | index | archive | help
Quoting Sergey Babkin <babkin@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.





Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20060519151624.sd392gz3swcc8800>