X-Git-Url: http://git.cascardo.eti.br/?a=blobdiff_plain;f=Documentation%2Fkernel-doc-nano-HOWTO.txt;h=348b9e5e28fcd48c4249c10cdd8f0b1da4010df4;hb=47a01a0c94a3ff1716adb5f37b83975550e1ebbb;hp=4d04572b6549edef13d29a514124371b72863d10;hpb=f815c335d21f9965f8dbe142fd168aaba1baf98e;p=cascardo%2Flinux.git 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