From owner-cvs-src@FreeBSD.ORG  Fri May 26 18:20:43 2006
Return-Path: <owner-cvs-src@FreeBSD.ORG>
X-Original-To: cvs-src@FreeBSD.org
Delivered-To: cvs-src@FreeBSD.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 5153816ACDD;
	Fri, 26 May 2006 18:20:43 +0000 (UTC)
	(envelope-from phk@critter.freebsd.dk)
Received: from pfepa.post.tele.dk (pfepa.post.tele.dk [195.41.46.235])
	by mx1.FreeBSD.org (Postfix) with ESMTP id E15F143D46;
	Fri, 26 May 2006 18:20:42 +0000 (GMT)
	(envelope-from phk@critter.freebsd.dk)
Received: from critter.freebsd.dk (0x50a07cfc.naenxx7.adsl-dhcp.tele.dk
	[80.160.124.252])
	by pfepa.post.tele.dk (Postfix) with ESMTP id 32083FAC01E;
	Fri, 26 May 2006 20:20:38 +0200 (CEST)
Received: from critter.freebsd.dk (localhost [127.0.0.1])
	by critter.freebsd.dk (8.13.6/8.13.6) with ESMTP id k4QIKa7c010527;
	Fri, 26 May 2006 20:20:36 +0200 (CEST)
	(envelope-from phk@critter.freebsd.dk)
To: Alexander Leidinger <netchild@FreeBSD.org>
From: "Poul-Henning Kamp" <phk@phk.freebsd.dk>
In-Reply-To: Your message of "Fri, 26 May 2006 18:06:07 -0000."
	<200605261806.k4QI67D3007680@repoman.freebsd.org> 
Date: Fri, 26 May 2006 20:20:36 +0200
Message-ID: <10526.1148667636@critter.freebsd.dk>
Sender: phk@critter.freebsd.dk
Cc: cvs-src@FreeBSD.org, src-committers@FreeBSD.org, cvs-all@FreeBSD.org
Subject: Re: cvs commit: src/sys/doc/subsys Dependencies Doxyfile-cam
	Doxyfile-crypto Doxyfile-dev_pci Doxyfile-dev_sound
	Doxyfile-dev_usb Doxyfile-geom Doxyfile-i4b Doxyfile-kern
	Doxyfile-libkern Doxyfile-linux Doxyfile-net80211 ... 
X-BeenThere: cvs-src@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
List-Id: CVS commit messages for the src tree <cvs-src.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/cvs-src>,
	<mailto:cvs-src-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/cvs-src>
List-Post: <mailto:cvs-src@freebsd.org>
List-Help: <mailto:cvs-src-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/cvs-src>,
	<mailto:cvs-src-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Fri, 26 May 2006 18:20:51 -0000

In message <200605261806.k4QI67D3007680@repoman.freebsd.org>, Alexander Leiding
er writes:

>  This is the kernel subsystem API documentation generation framework.
>  
>  It uses doxygen to generate the API documentation. For each subsystem
>  a very small (about 20 lines with comments) subsystem specific Doxyfile
>  has to be written (have a look at the README for more). All common doxygen
>  options are specified in a separate file.

Now, this is all well and good, but the most critical question in
my mind is: how do we prevent (or alternatively: mark up) documentation
for functions which are not supposed to be public ?

-- 
Poul-Henning Kamp       | UNIX since Zilog Zeus 3.20
phk@FreeBSD.ORG         | TCP/IP since RFC 956
FreeBSD committer       | BSD since 4.3-tahoe    
Never attribute to malice what can adequately be explained by incompetence.