kernel-doc: allow multi-line declaration purpose descriptions
authorJohannes Weiner <hannes@cmpxchg.org>
Fri, 18 Sep 2009 02:26:53 +0000 (19:26 -0700)
committerLinus Torvalds <torvalds@linux-foundation.org>
Fri, 18 Sep 2009 16:48:52 +0000 (09:48 -0700)
commit6423133bdee0e07d1c2f8411cb3fe676c207ba33
treeb50ee9b09359d9556542b08b5b4b1d63ac47bd53
parent27f5de7963f46388932472b660f2f9a86ab58454
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>
Documentation/kernel-doc-nano-HOWTO.txt
scripts/kernel-doc