abraham.varricatt
April 28th, 2009, 12:27 PM
If you do a quick search online, you'll find that the most popular way to document your code is using doxygen. This makes it easy for anyone to create documentation about the source code.
The Linux kernel follows something similar that they call kernel-docs (I think). If you download the kernel you'll find that we can generate a HTML-based document(s) about the kernel. Basic information is given in the file kernel-doc-nano-HOWTO.txt (http://www.mjmwired.net/kernel/Documentation/kernel-doc-nano-HOWTO.txt) (in the kernel), but reading it makes my head spin. :???:
This is a great help, but what if all you want is to document a section of it? Anyone knows the command(s) on how to do this? :confused:
I'm trying to document a folder in the kernel.
The Linux kernel follows something similar that they call kernel-docs (I think). If you download the kernel you'll find that we can generate a HTML-based document(s) about the kernel. Basic information is given in the file kernel-doc-nano-HOWTO.txt (http://www.mjmwired.net/kernel/Documentation/kernel-doc-nano-HOWTO.txt) (in the kernel), but reading it makes my head spin. :???:
This is a great help, but what if all you want is to document a section of it? Anyone knows the command(s) on how to do this? :confused:
I'm trying to document a folder in the kernel.