linux-3.3/scripts/kernel-doc

77 # (* @parameterx: (description of parameter x)?)*
90 # after the last parameter specification.
155 # '@parameter' - name of a parameter
191 			$type_param, "<parameter>\$1</parameter>" );
199 			 $type_param, "<parameter>\$1</parameter>" );
386 #	print STDERR "parameter def '$1' = '$contents'\n";
391 #	print STDERR "parameter def '...' = '$contents'\n";
436 #  parameterdescs => %parameter descriptions
492     my ($parameter);
498     foreach $parameter (@{$args{'parameterlist'}}) {
499 	print " <b>" . $parameter . "</b>";
510     foreach $parameter (@{$args{'parameterlist'}}) {
511 	print "<dt><b>" . $parameter . "</b>\n";
513 	output_highlight($args{'parameterdescs'}{$parameter});
523     my ($parameter);
535     my ($parameter);
539     foreach $parameter (@{$args{'parameterlist'}}) {
540 	if ($parameter =~ /^#/) {
541 		print "$parameter<br>\n";
544 	my $parameter_name = $parameter;
548 	$type = $args{'parametertypes'}{$parameter};
551 	    print "&nbsp; &nbsp; <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n";
554 	    print "&nbsp; &nbsp; <i>$1</i> <b>$parameter</b>$2;<br>\n";
556 	    print "&nbsp; &nbsp; <i>$type</i> <b>$parameter</b>;<br>\n";
563     foreach $parameter (@{$args{'parameterlist'}}) {
564 	($parameter =~ /^#/) && next;
566 	my $parameter_name = $parameter;
570 	print "<dt><b>" . $parameter . "</b>\n";
582     my ($parameter, $section);
590     foreach $parameter (@{$args{'parameterlist'}}) {
591 	$type = $args{'parametertypes'}{$parameter};
594 	    print "<i>$1</i><b>$parameter</b>) <i>($2)</i>";
596 	    print "<i>" . $type . "</i> <b>" . $parameter . "</b>";
607     foreach $parameter (@{$args{'parameterlist'}}) {
608 	my $parameter_name = $parameter;
612 	print "<dt><b>" . $parameter . "</b>\n";
624     my ($parameter, $section);
662     my ($parameter, $section);
696 	foreach $parameter (@{$args{'parameterlist'}}) {
697 	    $type = $args{'parametertypes'}{$parameter};
700 		print "   <paramdef>$1<parameter>$parameter</parameter>)\n";
704 		print " <parameter>$parameter</parameter></paramdef>\n";
717 	foreach $parameter (@{$args{'parameterlist'}}) {
718 	    my $parameter_name = $parameter;
721 	    print "  <varlistentry>\n   <term><parameter>$parameter</parameter></term>\n";
740     my ($parameter, $section);
769     foreach $parameter (@{$args{'parameterlist'}}) {
770 	if ($parameter =~ /^#/) {
771 	    my $prm = $parameter;
779 	my $parameter_name = $parameter;
784 	$type = $args{'parametertypes'}{$parameter};
787 	    print "  $1 $parameter) ($2);\n";
790 	    print "  $1 $parameter$2;\n";
792 	    print "  " . $type . " " . $parameter . ";\n";
804     foreach $parameter (@{$args{'parameterlist'}}) {
805       ($parameter =~ /^#/) && next;
807       my $parameter_name = $parameter;
813       print "      <term>$parameter</term>\n";
833     my ($parameter, $section);
864     foreach $parameter (@{$args{'parameterlist'}}) {
865 	print "  $parameter";
879     foreach $parameter (@{$args{'parameterlist'}}) {
880       my $parameter_name = $parameter;
884       print "      <term>$parameter</term>\n";
901     my ($parameter, $section);
938     my ($parameter, $section);
972     my ($parameter, $section);
989 	foreach $parameter (@{$args{'parameterlist'}}) {
990 	    $type = $args{'parametertypes'}{$parameter};
993 		print "   <paramdef>$1 <parameter>$parameter</parameter>)\n";
997 		print " <parameter>$parameter</parameter></paramdef>\n";
1010 	foreach $parameter (@{$args{'parameterlist'}}) {
1011 	    my $parameter_name = $parameter;
1014 	    print "  <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n";
1050     my ($parameter, $section);
1067     foreach my $parameter (@{$args{'parameterlist'}}) {
1071 	$type = $args{'parametertypes'}{$parameter};
1074 	    print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n";
1077 	    print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n";
1084     foreach $parameter (@{$args{'parameterlist'}}) {
1085 	my $parameter_name = $parameter;
1088 	print ".IP \"" . $parameter . "\" 12\n";
1101     my ($parameter, $section);
1112     foreach my $parameter (@{$args{'parameterlist'}}) {
1113 	print ".br\n.BI \"    $parameter\"\n";
1125     foreach $parameter (@{$args{'parameterlist'}}) {
1126 	my $parameter_name = $parameter;
1129 	print ".IP \"" . $parameter . "\" 12\n";
1142     my ($parameter, $section);
1152     foreach my $parameter (@{$args{'parameterlist'}}) {
1153 	if ($parameter =~ /^#/) {
1154 	    print ".BI \"$parameter\"\n.br\n";
1157 	my $parameter_name = $parameter;
1161 	$type = $args{'parametertypes'}{$parameter};
1164 	    print ".BI \"    " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\"\n;\n";
1167 	    print ".BI \"    " . $1 . "\ \" " . $parameter . $2 . " \"" . "\"\n;\n";
1170 	    print ".BI \"    " . $type . "\" " . $parameter . " \"" . "\"\n;\n";
1177     foreach $parameter (@{$args{'parameterlist'}}) {
1178 	($parameter =~ /^#/) && next;
1180 	my $parameter_name = $parameter;
1184 	print ".IP \"" . $parameter . "\" 12\n";
1197     my ($parameter, $section);
1212     my ($parameter, $section);
1227     my ($parameter, $section);
1242     foreach my $parameter (@{$args{'parameterlist'}}) {
1243 	$type = $args{'parametertypes'}{$parameter};
1246 	    print $1 . $parameter . ") (" . $2;
1248 	    print $type . " " . $parameter;
1260     foreach $parameter (@{$args{'parameterlist'}}) {
1261 	my $parameter_name = $parameter;
1264 	print $parameter . "\n\t" . $args{'parameterdescs'}{$parameter_name} . "\n";
1285     my ($parameter);
1292     foreach $parameter (@{$args{'parameterlist'}}) {
1293 	print "\t$parameter";
1303     foreach $parameter (@{$args{'parameterlist'}}) {
1304 	print "$parameter\n\t";
1305 	print $args{'parameterdescs'}{$parameter} . "\n";
1314     my ($parameter);
1325     my ($parameter);
1329     foreach $parameter (@{$args{'parameterlist'}}) {
1330 	if ($parameter =~ /^#/) {
1331 	    print "$parameter\n";
1335 	my $parameter_name = $parameter;
1339 	$type = $args{'parametertypes'}{$parameter};
1342 	    print "\t$1 $parameter) ($2);\n";
1345 	    print "\t$1 $parameter$2;\n";
1347 	    print "\t" . $type . " " . $parameter . ";\n";
1353     foreach $parameter (@{$args{'parameterlist'}}) {
1354 	($parameter =~ /^#/) && next;
1356 	my $parameter_name = $parameter;
1360 	print "$parameter\n\t";
1369     my ($parameter, $section);
1407     my ($parameter, $section);
1686 	# warn if parameter has no description
1696 		print STDERR "Warning(${file}:$.): Function parameter ".
1701 			 " No description found for parameter '$param'\n";
1711 	# a parameter like "addr[6 + 2]" because it actually appears
1712 	# as "addr[6", "+", "2]" on the parameter list;
1715 	# "[blah" in a parameter string;
1735 			# ignore array size in a parameter string;
1739 			# parameter list is split at spaces;
1752 					"Excess function parameter " .
2153 		# @parameter line to signify start of description