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

The ker­nel sub­sys­tem API doc­u­men­ta­tion gen­er­a­tion framework.

Posted By netchild On In Docs,FreeBSD,Kernel | 1 Comment

I com­mit­ted the ker­nel sub­sys­tem API doc­u­men­ta­tion gen­er­a­tion frame­work. It allows to gen­er­ate the API doc­u­men­ta­tion of a sub­sys­tem (with doxy­gen [1]) just by adding a short con­fig file (around 22 lines with com­ments and blank lines, maybe 14 lines with­out com­ments and blank lines). Here’s an exam­ple of such a config:

—snip—
PROJECT_NAME = “FreeB­SD ker­nel sound device code”
OUTPUT_DIRECTORY = $(DOXYGEN_DEST_PATH)/dev_sound/
EXTRACT_ALL = YES # for undoc­u­ment­ed src, no warn­ings enabled
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­fig­ured to not only gen­er­ate the HTML ver­sion, but also a PDF version.

Sub­sys­tems for which docs are gen­er­at­ed cur­rent­ly (con­figs for oth­er sub­sys­tems are welcome):

Peo­ple which want to help doc­u­ment­ing the code [2] may want to have a look at the spe­cial com­mands doxy­gen under­stands [3].

Read­ers who viewed this page, also viewed:

[8] [9] [10] [11] [12] [13] [14] [15] [16] [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]Share/Save [49]
1 Comment (Open | Close)

1 Comment To "The ker­nel sub­sys­tem API doc­u­men­ta­tion gen­er­a­tion framework."

#1 Pingback By FreeNAS & Sen­sors for FreeB­SD « The Dai­ly BSD On December 7, 2009 @ 05:03

[…] The ker­nel sub­sys­tem API doc­u­men­ta­tion gen­er­a­tion framework. […]