Messages in this thread | | | Date | Sun, 26 Sep 1999 19:45:48 +0200 (MET_DST) | From | David Weinehall <> | Subject | Re: [patch] kernel API documentation system |
| |
On Sun, 26 Sep 1999, Jeff Garzik wrote:
> Attached is a simple kernel API documentation system, based on the one > used in GNOME. Documentation, TODO list, two examples, and the > kernel-doc.pl are all included in this patch (diff'd against 2.3.18ac8). > > The general idea is to document API functions inside the source code, > and then use the new "make apidocs" target to re-generate the kernel API > documentation. kernel-doc.pl is very flexible and can output DocBook, > man, HTML, and other formats. > > The current "make apidocs" command creates > Documentation/kernel-api.html, containing all documentation. Eventually > this system should generate individual man pages, one per kernel API > function, in addition to the existing kernel-api.html file.
Well, if this goes into the kernel, at least I can promise to document the MCA-code in a proper manner.
/David _ _ // David Weinehall <tao@acc.umu.se> /> Northern lights wander \\ // Project MCA Linux hacker // Dance across the winter sky // \> http://www.acc.umu.se/~tao/ </ Full colour fire </
- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.rutgers.edu Please read the FAQ at http://www.tux.org/lkml/
| |