On Thu, Jun 10, 2004 at 06:14:33PM -0500, Timur Tabi wrote: > Greg KH wrote: > > >Did you read the file Documentation/CodingStyle? Specifically the > >section about comments? > > Yes, but it doesn't say a lot. For one thing, it only talks about > comments for functions. Then that's all you need :) Anything more than that is fluff. For more details, see my 2002 OLS paper about kernel coding style. > >If you want to use comments, please use the doc-book-like style comments > >as specified in the file Documentation/kernel-doc-nano-HOWTO.txt > > Well, that text file is a little terse, and (again) it only talks about > function comments. Is there an easier-to-read and more complete > description of docbook-like comments? See my above mentioned paper, it explains it a bit better (I think...) If not, feel free to ask specific questions. Also take a look at some code that implements it (like the public functions in drivers/usb/core/usb.c for example.) thanks, greg k-h -- Kernelnewbies: Help each other learn about the Linux kernel. Archive: http://mail.nl.linux.org/kernelnewbies/ FAQ: http://kernelnewbies.org/faq/
