Date: Thu, 25 Oct 2007 10:36:11 -0700
From: Randy Dunlap <rdunlap@xenotime.net>
To: Matt Mackall <mpm@selenic.com>
Cc: linux-kernel@vger.kernel.org, akpm@linux-foundation.org,
       Johannes Berg <johannes@sipsolutions.net>, sam@ravnborg.org
Subject: Re: [PATCH 0/6] kernel-doc: add DOC: sections support
Message-Id: <20071025103611.f2ae216f.rdunlap@xenotime.net>
In-Reply-To: <20071025172932.GN17536@waste.org>
References: <11932637282902@xenotime.net>
	<20071025172932.GN17536@waste.org>
Organization: YPO4
Mime-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 1023
Lines: 33

On Thu, 25 Oct 2007 12:29:32 -0500 Matt Mackall wrote:

> On Wed, Oct 24, 2007 at 03:08:48PM -0700, Randy Dunlap wrote:
> > 
> > This patch series from Johannes Berg adds support for DOC: sections
> > that are embedded in source files.
> 
> What do these look like?

There are currently 2 files in the kernel tree that contain DOC:
sections.  These are not used in the docbooks, but you can see what
they look like here:

./drivers/net/3c501.c: * DOC: 3c501 Card Notes
./drivers/net/3c501.c: * DOC: Problems
./drivers/net/3c527.c: * DOC: Traps for the unwary
./drivers/net/3c527.c: * DOC: Theory Of Operation
./drivers/net/3c527.c: * DOC: Notes

Also, Johannes has patches to use DOC: in mac80211 files.


> Kerneldoc's documentation is sadly lacking..

point taken.

---
~Randy
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/