summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorJohannes Weiner <hannes@cmpxchg.org>2009-09-17 19:26:53 -0700
committerLinus Torvalds <torvalds@linux-foundation.org>2009-09-18 09:48:52 -0700
commit6423133bdee0e07d1c2f8411cb3fe676c207ba33 (patch)
treeb50ee9b09359d9556542b08b5b4b1d63ac47bd53 /Documentation
parent27f5de7963f46388932472b660f2f9a86ab58454 (diff)
downloadlinux-6423133bdee0e07d1c2f8411cb3fe676c207ba33.tar.gz
linux-6423133bdee0e07d1c2f8411cb3fe676c207ba33.tar.bz2
linux-6423133bdee0e07d1c2f8411cb3fe676c207ba33.zip
kernel-doc: allow multi-line declaration purpose descriptions
Allow the short description after symbol name and dash in a kernel-doc comment to span multiple lines, e.g. like this: /** * unmap_mapping_range - unmap the portion of all mmaps in the * specified address_space corresponding to the specified * page range in the underlying file. * @mapping: the address space containing mmaps to be unmapped. * ... */ The short description ends with a parameter description, an empty line or the end of the comment block. Signed-off-by: Johannes Weiner <hannes@cmpxchg.org> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/kernel-doc-nano-HOWTO.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt
index 4d04572b6549..348b9e5e28fc 100644
--- a/Documentation/kernel-doc-nano-HOWTO.txt
+++ b/Documentation/kernel-doc-nano-HOWTO.txt
@@ -66,7 +66,9 @@ Example kernel-doc function comment:
* The longer description can have multiple paragraphs.
*/
-The first line, with the short description, must be on a single line.
+The short description following the subject can span multiple lines
+and ends with an @argument description, an empty line or the end of
+the comment block.
The @argument descriptions must begin on the very next line following
this opening short function description line, with no intervening