diff options
author | Johannes Weiner <hannes@cmpxchg.org> | 2009-09-17 19:26:53 -0700 |
---|---|---|
committer | Linus Torvalds <torvalds@linux-foundation.org> | 2009-09-18 09:48:52 -0700 |
commit | 6423133bdee0e07d1c2f8411cb3fe676c207ba33 (patch) | |
tree | b50ee9b09359d9556542b08b5b4b1d63ac47bd53 /fs/befs/btree.h | |
parent | 27f5de7963f46388932472b660f2f9a86ab58454 (diff) |
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 'fs/befs/btree.h')
0 files changed, 0 insertions, 0 deletions