On Thu, Jun 10, 2004 at 05:19:24PM -0500, Timur Tabi wrote: > Hi, > > I'm working on a driver that I might try to get incorporated into the > official Linux kernel source tree. One of the things I've noticed while > looking at the current Linux kernel source code is that it's very poorly > documented, at least by my standards. > > For my code, I want to add lots of Javadoc-style comments. For > instance, I comment every function and structure, and almost every local > variable. > > Would Linus and/or his lieutenants reject my code because it's commented > too much? Did you read the file Documentation/CodingStyle? Specifically the section about comments? 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 Good luck, greg k-h -- Kernelnewbies: Help each other learn about the Linux kernel. Archive: http://mail.nl.linux.org/kernelnewbies/ FAQ: http://kernelnewbies.org/faq/
