Commit 47bcacfd authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

scripts: kernel-doc: fix typedef identification 



Some typedef expressions are output as normal functions.

As we need to be clearer about the type with Sphinx 3.x,
detect such cases.

While here, fix a wrongly-indented block.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
parent eab795dd

scripts/kernel-doc

+41 −23
Original line number Diff line number Diff line
@@ -1760,9 +1760,13 @@ sub dump_function($$) { 
	    check_return_section($file, $declaration_name, $return_type);

    }



    # The function parser can be called with a typedef parameter.

    # Handle it.

    if ($return_type =~ /typedef/) {

	output_declaration($declaration_name,

			   'function',

			   {'function' => $declaration_name,

			    'typedef' => 1,

			    'module' => $modulename,

			    'functiontype' => $return_type,

			    'parameterlist' => \@parameterlist,
@@ -1772,6 +1776,20 @@ sub dump_function($$) { 
			    'sections' => \%sections,

			    'purpose' => $declaration_purpose

			   });

    } else {

	output_declaration($declaration_name,

			   'function',

			   {'function' => $declaration_name,

			    'module' => $modulename,

			    'functiontype' => $return_type,

			    'parameterlist' => \@parameterlist,

			    'parameterdescs' => \%parameterdescs,

			    'parametertypes' => \%parametertypes,

			    'sectionlist' => \@sectionlist,

			    'sections' => \%sections,

			    'purpose' => $declaration_purpose

			   });

    }

}



sub reset_state {

CRA Git | Maintained and supported by SUSTech CRA and CCSE