• Randy Dunlap's avatar
    [PATCH] kernel-doc: warn on malformed function docs. · 850622df
    Randy Dunlap authored
    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: default avatarRandy Dunlap <rdunlap@xenotime.net>
    Signed-off-by: default avatarAndrew Morton <akpm@osdl.org>
    Signed-off-by: default avatarLinus Torvalds <torvalds@osdl.org>
    850622df
kernel-doc 50.7 KB