Documenting device driver methods

Stefan Bethke stb at
Tue Dec 6 17:31:36 UTC 2011

Am 06.12.2011 um 15:34 schrieb Stefan Bethke:

> I noticed that very few (if any) device drivers have their interface methods documented (e.g. iicbus, iicbb, gpiobus, gpio).
> Where should such documentation go? In the driver specific man page, in a separate section 9 page per method, or a single section 9 man page?
> Is there a preferred style for these?

Would it make sense to document device classes in the device section with the class name in all capitals, e.g. foo_if.m as FOO.4?


Stefan Bethke <stb at>   Fon +49 151 14070811

More information about the freebsd-doc mailing list