From owner-cvs-all@FreeBSD.ORG  Fri May 19 13:16:59 2006
Return-Path: <owner-cvs-all@FreeBSD.ORG>
X-Original-To: cvs-all@FreeBSD.org
Delivered-To: cvs-all@FreeBSD.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 6EB3216A42F;
	Fri, 19 May 2006 13:16:59 +0000 (UTC)
	(envelope-from Alexander@Leidinger.net)
Received: from www.ebusiness-leidinger.de (jojo.ms-net.de [84.16.236.246])
	by mx1.FreeBSD.org (Postfix) with ESMTP id AB47943D46;
	Fri, 19 May 2006 13:16:58 +0000 (GMT)
	(envelope-from Alexander@Leidinger.net)
Received: from Andro-Beta.Leidinger.net (p54A5F718.dip.t-dialin.net
	[84.165.247.24]) (authenticated bits=0)
	by www.ebusiness-leidinger.de (8.13.4/8.13.1) with ESMTP id
	k4JD5bbS070141; Fri, 19 May 2006 15:05:38 +0200 (CEST)
	(envelope-from Alexander@Leidinger.net)
Received: from localhost (localhost [127.0.0.1])
	by Andro-Beta.Leidinger.net (8.13.4/8.13.3) with ESMTP id
	k4JDGOGx056856; Fri, 19 May 2006 15:16:25 +0200 (CEST)
	(envelope-from Alexander@Leidinger.net)
Received: from pslux.cec.eu.int (pslux.cec.eu.int [158.169.9.14]) by
	webmail.leidinger.net (Horde MIME library) with HTTP; Fri, 19 May 2006
	15:16:24 +0200
Message-ID: <20060519151624.sd392gz3swcc8800@netchild.homeip.net>
X-Priority: 3 (Normal)
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>
References: <16489295.8854801148037298444.JavaMail.root@vms168.mailsrvcs.net>
In-Reply-To: <16489295.8854801148037298444.JavaMail.root@vms168.mailsrvcs.net>
MIME-Version: 1.0
Content-Type: text/plain;
	charset=UTF-8;
	DelSp="Yes";
	format="flowed"
Content-Disposition: inline
Content-Transfer-Encoding: 7bit
User-Agent: Internet Messaging Program (IMP) H3 (4.1) / FreeBSD-4.11
X-Virus-Scanned: by amavisd-new
X-Mailman-Approved-At: Fri, 19 May 2006 14:10:54 +0000
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
X-BeenThere: cvs-all@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
List-Id: CVS commit messages for the entire tree <cvs-all.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/cvs-all>,
	<mailto:cvs-all-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/cvs-all>
List-Post: <mailto:cvs-all@freebsd.org>
List-Help: <mailto:cvs-all-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/cvs-all>,
	<mailto:cvs-all-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Fri, 19 May 2006 13:17:00 -0000

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.