Date: Tue, 6 Dec 2011 18:31:34 +0100 From: Stefan Bethke <stb@lassitu.de> To: freebsd-doc <freebsd-doc@freebsd.org> Subject: Re: Documenting device driver methods Message-ID: <176FCC23-A2BB-4C51-8219-A3D06515A30C@lassitu.de> In-Reply-To: <77AB0982-9E21-4BB3-8CE5-E390112E27B8@lassitu.de> References: <77AB0982-9E21-4BB3-8CE5-E390112E27B8@lassitu.de>
next in thread | previous in thread | raw e-mail | index | archive | help
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). >=20 > 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? >=20 > 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 --=20 Stefan Bethke <stb@lassitu.de> Fon +49 151 14070811
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?176FCC23-A2BB-4C51-8219-A3D06515A30C>