* Kerneldoc comments in files not mentioned by *.tmpl
@ 2007-12-28 13:40 Andi Kleen
0 siblings, 0 replies; only message in thread
From: Andi Kleen @ 2007-12-28 13:40 UTC (permalink / raw)
To: randy.dunlap, linux-kernel, rob
I added kerneldoc comments to some files and was a little surprised that
they didn't appear in make mandocs output. It turns out only functions in files
mentioned in Documentation/DocBook/*.tmpl are extracted. Since that's a
pretty unknown requirement (at least I didn't know it) I suppose a lot
of the kerneldoc annotations actually are never generated because of this.
Should that be changed and let the scripts hunt for kerneldoc in all
source files?
A potential problem is that already the kerneldocs contain a lot
of fairly useless driver internal funcions (e.g. nobody does care
a lot about internal MPT interfaces). But that problem is already
there and it's better to have too many than not enough in mandocs.
-Andi
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2007-12-28 13:57 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2007-12-28 13:40 Kerneldoc comments in files not mentioned by *.tmpl Andi Kleen
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox