iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

kernel-doc: use rst C domain directives and references for types

Browse Source 
First, the headings for structs, enums and typedefs will be similar to
functions. Second, this provides a kind of namespace for cross
references. Third, and most importantly, the return and parameter types
from .. c:function:: definitions will automagically become cross
references to the documented types.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Jani Nikula 2016-05-12 16:15:38 +03:00 committed by Jonathan Corbet
parent c0d1b6ee78
commit 6285097654
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
scripts/kernel-doc
View File

@ -275,9 +275,9 @@ my $blankline_text = "";
my @highlights_rst = ( my @highlights_rst = (
[$type_constant, "``\$1``"], [$type_constant, "``\$1``"],
[$type_func, "\\:c\\:func\\:`\$1`"], [$type_func, "\\:c\\:func\\:`\$1`"],
[$type_struct_full, "\\:ref\\:`\$1 \$2`"], [$type_struct_full, "\\:c\\:type\\:`\$1 \$2 <\$2>`"],
[$type_enum_full, "\\:ref\\:`\$1 \$2`"], [$type_enum_full, "\\:c\\:type\\:`\$1 \$2 <\$2>`"],
[$type_struct, "\\:ref\\:`struct \$1`"], [$type_struct, "\\:c\\:type\\:`struct \$1 <\$1>`"],
[$type_param, "**\$1**"] [$type_param, "**\$1**"]
); );
my $blankline_rst = "\n"; my $blankline_rst = "\n";
@ -1835,10 +1835,9 @@ sub output_enum_rst(%) {
my %args = %{$_[0]}; my %args = %{$_[0]};
my ($parameter); my ($parameter);
my $count; my $count;
my $name = "enum " . $args{'enum'}; my $name = "enum " . $args{'enum'};
print ".. _" . $name . ":\n\n";
print "**$name**\n\n"; print "\n\n.. c:type:: " . $name . "\n\n";
print " " . $args{'purpose'} . "\n\n"; print " " . $args{'purpose'} . "\n\n";
print "..\n\n:Constants:\n\n"; print "..\n\n:Constants:\n\n";
@ -1863,8 +1862,9 @@ sub output_typedef_rst(%) {
my $count; my $count;
my $name = "typedef " . $args{'typedef'}; my $name = "typedef " . $args{'typedef'};
print "**$name**\n\n"; ### FIXME: should the name below contain "typedef" or not?
print $args{'purpose'} . "\n\n"; print "\n\n.. c:type:: " . $name . "\n\n";
print " " . $args{'purpose'} . "\n\n";
output_section_rst(@_); output_section_rst(@_);
} }
@ -1874,8 +1874,7 @@ sub output_struct_rst(%) {
my ($parameter); my ($parameter);
my $name = $args{'type'} . " " . $args{'struct'}; my $name = $args{'type'} . " " . $args{'struct'};
print ".. _" . $name . ":\n\n"; print "\n\n.. c:type:: " . $name . "\n\n";
print "**$name**\n\n";
print " " . $args{'purpose'} . "\n\n"; print " " . $args{'purpose'} . "\n\n";
print ":Definition:\n\n"; print ":Definition:\n\n";