Re: Javadoc comments in kernel source?

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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.


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? I've tried searching the web, but I didn't find anything applicable - mostly just pages on how to extract docbook info.


BTW, Greg, I really enjoy your articles in Linux Journal.

--
Timur Tabi
Staff Software Engineer
timur.tabi@ammasso.com

--
Kernelnewbies: Help each other learn about the Linux kernel.
Archive:       http://mail.nl.linux.org/kernelnewbies/
FAQ:           http://kernelnewbies.org/faq/


[Index of Archives]     [Newbies FAQ]     [Linux Kernel Mentors]     [Linux Kernel Development]     [IETF Annouce]     [Git]     [Networking]     [Security]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux SCSI]     [Linux ACPI]
  Powered by Linux