diff options
author | Randy Dunlap <rdunlap@xenotime.net> | 2006-06-25 08:48:55 -0400 |
---|---|---|
committer | Linus Torvalds <torvalds@g5.osdl.org> | 2006-06-25 13:01:20 -0400 |
commit | 850622dfaf3d62907c96707773e0f8e84b3c0c06 (patch) | |
tree | 905e002ee082453ab8da9f4a8fe805d69f59bc45 /README | |
parent | 9c8ef5614da22666e339b125263d315cfaa89109 (diff) |
[PATCH] kernel-doc: warn on malformed function docs.
When the verbose (-v) option is used with scripts/kernel-doc, this option
reports when the kernel-doc format is malformed and apparently contains
function description lines before function parameters. In these cases, the
kernel-doc script will print something like: Warning(filemap.c:335):
contents before sections
I have fixed the problems in mm/filemap.c and added lots of kernel-doc to
that file (posted to the linux-mm mailing list Mon. 2006-June-12).
The real goal (as requested by Andrew Morton) is to allow the short
function description to be more than one line long. This patch is both a
kernel-doc checker and a tool en route to that goal.
Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Diffstat (limited to 'README')
0 files changed, 0 insertions, 0 deletions