Commit 3bdd9f07 authored by Jonathan Neuschäfer's avatar Jonathan Neuschäfer Committed by Jonathan Corbet
Browse files

scripts: kernel-doc: Remove workaround for @param... syntax 



Commit 43756e34 ("scripts/kernel-doc: Add support for named variable
macro arguments") improved how named variable macro arguments are
handled, and changed how they are documented in kerneldoc comments
from "@param...", to "@param", deprecating the old syntax.

All users of the old syntax have since been converted, so this commit
finally removes support for it.

The output of "make htmldocs" is the same with and without this commit.

Signed-off-by: default avatarJonathan Neuschäfer <j.neuschaefer@gmx.net>
Link: https://lore.kernel.org/r/20230129150435.1510400-1-j.neuschaefer@gmx.net


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 19a12613

scripts/kernel-doc

+0 −11
Original line number Diff line number Diff line
@@ -2079,17 +2079,6 @@ sub process_name($$) { 
sub process_body($$) {

    my $file = shift;



    # Until all named variable macro parameters are

    # documented using the bare name (`x`) rather than with

    # dots (`x...`), strip the dots:

    if ($section =~ /\w\.\.\.$/) {

	$section =~ s/\.\.\.$//;



	if ($verbose) {

	    emit_warning("${file}:$.", "Variable macro arguments should be documented without dots\n");

	}

    }



    if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {

	dump_section($file, $section, $contents);

	$section = $section_default;