- Alexander Leidinger - http://www.leidinger.net/blog -

The ker­nel sub­sys­tem API doc­u­ment­a­tion gen­er­a­tion frame­work.

I com­mit­ted the ker­nel [1] sub­sys­tem API doc­u­ment­a­tion gen­er­a­tion frame­work. It al­lows to gen­er­ate the API doc­u­ment­a­tion of a sub­sys­tem (with doxy­gen [2]) just by adding a short con­fig [3] file (around 22 lines with com­ments and blank lines, maybe 14 lines without com­ments and blank lines). Here’s an ex­ample of such a con­fig:

—snip—
PROJECT_NAME = “FreeBSD [4] ker­nel [5] sound device code”
OUTPUT_DIRECTORY = $(DOXYGEN_DEST_PATH)/dev_sound/
EXTRACT_ALL = YES # for un­doc­u­mented src, no warn­ings en­abled
INPUT = $(DOXYGEN_SRC_PATH)/dev/sound/

GENERATE_TAGFILE = dev_sound/dev_sound.tag
TAGFILES = dev_pci/dev_pci.tag=../../dev_pci/html \
dev_usb/dev_usb.tag=../../dev_usb/html
@INCLUDE_PATH = $(DOXYGEN_INCLUDE_PATH)
@INCLUDE = common-Doxyfile
—snip—

The frame­work is con­figured to not only gen­er­ate the HTML ver­sion, but also a PDF ver­sion.

Sub­sys­tems [6] for which docs are gen­er­ated cur­rently (con­figs for other sub­sys­tems are wel­come):

People [10] which want to help doc­u­ment­ing the code [11] may want to have a look at the spe­cial com­mands doxy­gen un­der­stands [12].

[17] [18] [19] [20] [21] [22] [23] [24] [25] [26] [27] [28] [29] [30] [31] [32] [33] [34] [35] [36] [37] [38] [39] [40] [41] [42] [43] [44] [45] [46] [47] [48] [49] [50] [51] [52] [53] [54] [55] [56] [57] [58] [59] [60] [61]Share/Save [62]
1 Comment (Open | Close)

1 Comment To "The ker­nel sub­sys­tem API doc­u­ment­a­tion gen­er­a­tion frame­work."

#1 Pingback By FreeNAS & Sensors for FreeBSD « The Daily BSD On December 7, 2009 @ 05:03

[…] The ker­nel sub­sys­tem API doc­u­ment­a­tion gen­er­a­tion frame­work. […]