> > even for the whole kernel :-O)? I would support that...
> 
> Yes
> 
> Its a slightly warped variant on javadoc.

... which applies better to kernel APIs (like usbcore) than to
device drivers.  Drivers basically consume APIs rather than
exporting them, so a big chunk of the kernel isn't a good match
for kerneldoc.

I did some hacks a while back to generate some documentation
for device drivers, but stopped when I got the USB drivers to say
what devices etc they support.   (Didn'd do PCI, but someone
else could do so.)  Sample output:

    http://linux-hotplug.sourceforge.net/kernel/kernel.html#c36b3b4b7

That stuff uses XML docbook, current stuff, not the older SGML
stuff used by kerneldoc, and XSLT ... the work is mostly picking
through  MODULE_DEVICE_TABLE stuff (and usb.ids) to
catalogue the drivers.  Tools are in a tarball at the end of:

    http://linux-hotplug.sourceforge.net/?selected=links

I think it'd likely be better to sort by driver type (USB, PCI, ISA, ...)
rather than have one big table the way it is now ... easily done.


> Have a look in Documentation/DocBook. The kernel-doc tool can merge the
> descriptions with a template to create docbook manuals, and also extract the
> documents to man pages
> 
> Documentation/kernel-doc-nano-HOWTO.txt

Is anyone enhancing the kerneldoc stuff?

- Dave



_______________________________________________
[EMAIL PROTECTED]
To unsubscribe, use the last form field at:
http://lists.sourceforge.net/lists/listinfo/linux-usb-devel

Reply via email to