Commit 5219f18a authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

docs: Special-case function-pointer parameters in kernel-doc 



Add yet another regex to kernel-doc to trap @param() references separately
and not produce corrupt RST markup.

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

scripts/kernel-doc

+2 −0
Original line number Diff line number Diff line
@@ -212,6 +212,7 @@ my $anon_struct_union = 0; 
my $type_constant = '\%([-_\w]+)';

my $type_func = '(\w+)\(\)';

my $type_param = '\@(\w+)';

my $type_fp_param = '\@(\w+)\(\)';  # Special RST handling for func ptr params

my $type_struct = '\&((struct\s*)*[_\w]+)';

my $type_struct_xml = '\\&amp;((struct\s*)*[_\w]+)';

my $type_env = '(\$\w+)';
@@ -292,6 +293,7 @@ my @highlights_rst = ( 
                       # Note: need to escape () to avoid func matching later

                       [$type_member_func, "\\:c\\:type\\:`\$1\$2\\\\(\\\\) <\$1>`"],

                       [$type_member, "\\:c\\:type\\:`\$1\$2 <\$1>`"],

		       [$type_fp_param, "**\$1\\\\(\\\\)**"],

                       [$type_func, "\\:c\\:func\\:`\$1()`"],

                       [$type_struct_full, "\\:c\\:type\\:`\$1 \$2 <\$2>`"],

                       [$type_enum_full, "\\:c\\:type\\:`\$1 \$2 <\$2>`"],