More drivers avail­able in the FreeBSD-​kernel doxy­gen docs

Yes­ter­day I com­mit­ted some more con­figs to gen­er­ate doxy­gen doc­u­ment­a­tion of FreeBSD-​kernel drivers. I mech­an­ic­ally gen­er­ated miss­ing con­figs for sub­dir­ect­or­ies of src/​sys/​dev/​. This means there is no de­pend­ency in­form­a­tion in­cluded in the con­figs, and as such you will not get links e.g. to the PCI doc­u­ment­a­tion, if a driver calls func­tions in the PCI driver (feel free to tell me about such de­pend­en­cies).

If  you want to gen­er­ate the HTML or PDF ver­sion of some sub­sys­tem, just go to src/​tools/​kerneldoc/​subsys/​ an run “make” to get a list of tar­gets to build. As an ex­ample, “make dev_​sound” will gen­er­ate the HTML ver­sion for the sound sys­tem, “make pdf-​dev_​sound” gen­er­ates the PDF ver­sion. The sound sys­tem is prob­ably the most “nice” ex­ample, as it in­cludes a page with TODO items, and has even some real API docs in­stead of just the call-​graphs and such auto­mat­ic­ally gen­er­ated in­form­a­tion.

Some drivers already have (some) doxy­gen markup (I did just a quick grep for „/​*[*!]“ to de­tect doxy­gen markup in­dic­at­ors, no idea about the cov­er­age or qual­ity), namely:

There is more doc­u­ment­a­tion than only for those drivers, I just lis­ted those as there are at least parts of doxy­gen doc­u­ment­a­tion in­side.

Leave a Reply

Your email address will not be published. Required fields are marked *