lkml.org 
[lkml]   [1999]   [Sep]   [26]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
Subject[patch] kernel API documentation system
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.

Comments welcome. I think this system would be helpful to many.

Regards,

Jeff




--
Custom driver development | Never worry about theory as long
Open source programming | as the machinery does what it's
| supposed to do. -- R. A. Heinlein[unhandled content-type:application/x-gzip]
\
 
 \ /
  Last update: 2005-03-22 13:54    [W:0.047 / U:2.408 seconds]
©2003-2018 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site