documentation: how to use DOC: section blocks
authorRandy Dunlap <randy.dunlap@oracle.com>
Tue, 6 Jan 2009 22:42:43 +0000 (14:42 -0800)
committerLinus Torvalds <torvalds@linux-foundation.org>
Tue, 6 Jan 2009 23:59:28 +0000 (15:59 -0800)
commit28f4d75a618e52f93d8e4a3e7bc66db8c882d679
tree4e1009460067ee7883a9ea9f339881b06effa68e
parent58cc855c395fc22db996cc893134c4c690f0f0dc
documentation: how to use DOC: section blocks

Add info on how to use DOC: sections in kernel-doc.  DOC: sections enable
the addition of inline source file comments that are general in nature
instead of being specific to a function, struct, union, enum, or typedef.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Cc: Johannes Berg <johannes@sipsolutions.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Documentation/kernel-doc-nano-HOWTO.txt