scripts/kernel-doc

   1 #!/usr/bin/perl -w
   2
   3 use strict;
   4
   5 ## Copyright (c) 1998 Michael Zucchi, All Rights Reserved        ##
   6 ## Copyright (C) 2000, 1  Tim Waugh <twaugh@redhat.com>          ##
   7 ## Copyright (C) 2001  Simon Huggins                             ##
   8 ## Copyright (C) 2005-2007  Randy Dunlap                         ##
   9 ##                                                               ##
  10 ## #define enhancements by Armin Kuster <akuster@mvista.com>     ##
  11 ## Copyright (c) 2000 MontaVista Software, Inc.                  ##
  12 ##                                                               ##
  13 ## This software falls under the GNU General Public License.     ##
  14 ## Please read the COPYING file for more information             ##
  15
  16 # w.o. 03-11-2000: added the '-filelist' option.
  17
  18 # 18/01/2001 -  Cleanups
  19 #               Functions prototyped as foo(void) same as foo()
  20 #               Stop eval'ing where we don't need to.
  21 # -- huggie@earth.li
  22
  23 # 27/06/2001 -  Allowed whitespace after initial "/**" and
  24 #               allowed comments before function declarations.
  25 # -- Christian Kreibich <ck@whoop.org>
  26
  27 # Still to do:
  28 #       - add perldoc documentation
  29 #       - Look more closely at some of the scarier bits :)
  30
  31 # 26/05/2001 -  Support for separate source and object trees.
  32 #               Return error code.
  33 #               Keith Owens <kaos@ocs.com.au>
  34
  35 # 23/09/2001 - Added support for typedefs, structs, enums and unions
  36 #              Support for Context section; can be terminated using empty line
  37 #              Small fixes (like spaces vs. \s in regex)
  38 # -- Tim Jansen <tim@tjansen.de>
  39
  40
  41 #
  42 # This will read a 'c' file and scan for embedded comments in the
  43 # style of gnome comments (+minor extensions - see below).
  44 #
  45
  46 # Note: This only supports 'c'.
  47
  48 # usage:
  49 # kernel-doc [ -docbook | -html | -text | -man ] [ -no-doc-sections ]
  50 #           [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
  51 # or
  52 #           [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile
  53 #
  54 #  Set output format using one of -docbook -html -text or -man.  Default is man.
  55 #
  56 #  -no-doc-sections
  57 #       Do not output DOC: sections
  58 #
  59 #  -function funcname
  60 #       If set, then only generate documentation for the given function(s) or
  61 #       DOC: section titles.  All other functions and DOC: sections are ignored.
  62 #
  63 #  -nofunction funcname
  64 #       If set, then only generate documentation for the other function(s)/DOC:
  65 #       sections. Cannot be used together with -function (yes, that's a bug --
  66 #       perl hackers can fix it 8))
  67 #
  68 #  c files - list of 'c' files to process
  69 #
  70 #  All output goes to stdout, with errors to stderr.
  71
  72 #
  73 # format of comments.
  74 # In the following table, (...)? signifies optional structure.
  75 #                         (...)* signifies 0 or more structure elements
  76 # /**
  77 #  * function_name(:)? (- short description)?
  78 # (* @parameterx: (description of parameter x)?)*
  79 # (* a blank line)?
  80 #  * (Description:)? (Description of function)?
  81 #  * (section header: (section description)? )*
  82 #  (*)?*/
  83 #
  84 # So .. the trivial example would be:
  85 #
  86 # /**
  87 #  * my_function
  88 #  **/
  89 #
  90 # If the Description: header tag is omitted, then there must be a blank line
  91 # after the last parameter specification.
  92 # e.g.
  93 # /**
  94 #  * my_function - does my stuff
  95 #  * @my_arg: its mine damnit
  96 #  *
  97 #  * Does my stuff explained.
  98 #  */
  99 #
 100 #  or, could also use:
 101 # /**
 102 #  * my_function - does my stuff
 103 #  * @my_arg: its mine damnit
 104 #  * Description: Does my stuff explained.
 105 #  */
 106 # etc.
 107 #
 108 # Beside functions you can also write documentation for structs, unions,
 109 # enums and typedefs. Instead of the function name you must write the name
 110 # of the declaration;  the struct/union/enum/typedef must always precede
 111 # the name. Nesting of declarations is not supported.
 112 # Use the argument mechanism to document members or constants.
 113 # e.g.
 114 # /**
 115 #  * struct my_struct - short description
 116 #  * @a: first member
 117 #  * @b: second member
 118 #  *
 119 #  * Longer description
 120 #  */
 121 # struct my_struct {
 122 #     int a;
 123 #     int b;
 124 # /* private: */
 125 #     int c;
 126 # };
 127 #
 128 # All descriptions can be multiline, except the short function description.
 129 #
 130 # You can also add additional sections. When documenting kernel functions you
 131 # should document the "Context:" of the function, e.g. whether the functions
 132 # can be called form interrupts. Unlike other sections you can end it with an
 133 # empty line.
 134 # Example-sections should contain the string EXAMPLE so that they are marked
 135 # appropriately in DocBook.
 136 #
 137 # Example:
 138 # /**
 139 #  * user_function - function that can only be called in user context
 140 #  * @a: some argument
 141 #  * Context: !in_interrupt()
 142 #  *
 143 #  * Some description
 144 #  * Example:
 145 #  *    user_function(22);
 146 #  */
 147 # ...
 148 #
 149 #
 150 # All descriptive text is further processed, scanning for the following special
 151 # patterns, which are highlighted appropriately.
 152 #
 153 # 'funcname()' - function
 154 # '$ENVVAR' - environmental variable
 155 # '&struct_name' - name of a structure (up to two words including 'struct')
 156 # '@parameter' - name of a parameter
 157 # '%CONST' - name of a constant.
 158
 159 my $errors = 0;
 160 my $warnings = 0;
 161 my $anon_struct_union = 0;
 162
 163 # match expressions used to find embedded type information
 164 my $type_constant = '\%([-_\w]+)';
 165 my $type_func = '(\w+)\(\)';
 166 my $type_param = '\@(\w+)';
 167 my $type_struct = '\&((struct\s*)*[_\w]+)';
 168 my $type_struct_xml = '\\&amp;((struct\s*)*[_\w]+)';
 169 my $type_env = '(\$\w+)';
 170
 171 # Output conversion substitutions.
 172 #  One for each output format
 173
 174 # these work fairly well
 175 my %highlights_html = ( $type_constant, "<i>\$1</i>",
 176                         $type_func, "<b>\$1</b>",
 177                         $type_struct_xml, "<i>\$1</i>",
 178                         $type_env, "<b><i>\$1</i></b>",
 179                         $type_param, "<tt><b>\$1</b></tt>" );
 180 my $local_lt = "\\\\\\\\lt:";
 181 my $local_gt = "\\\\\\\\gt:";
 182 my $blankline_html = $local_lt . "p" . $local_gt;       # was "<p>"
 183
 184 # XML, docbook format
 185 my %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>",
 186                         $type_constant, "<constant>\$1</constant>",
 187                         $type_func, "<function>\$1</function>",
 188                         $type_struct_xml, "<structname>\$1</structname>",
 189                         $type_env, "<envar>\$1</envar>",
 190                         $type_param, "<parameter>\$1</parameter>" );
 191 my $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . "\n";
 192
 193 # gnome, docbook format
 194 my %highlights_gnome = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>",
 195                          $type_func, "<function>\$1</function>",
 196                          $type_struct, "<structname>\$1</structname>",
 197                          $type_env, "<envar>\$1</envar>",
 198                          $type_param, "<parameter>\$1</parameter>" );
 199 my $blankline_gnome = "</para><para>\n";
 200
 201 # these are pretty rough
 202 my %highlights_man = ( $type_constant, "\$1",
 203                        $type_func, "\\\\fB\$1\\\\fP",
 204                        $type_struct, "\\\\fI\$1\\\\fP",
 205                        $type_param, "\\\\fI\$1\\\\fP" );
 206 my $blankline_man = "";
 207
 208 # text-mode
 209 my %highlights_text = ( $type_constant, "\$1",
 210                         $type_func, "\$1",
 211                         $type_struct, "\$1",
 212                         $type_param, "\$1" );
 213 my $blankline_text = "";
 214
 215
 216 sub usage {
 217     print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man ] [ -no-doc-sections ]\n";
 218     print "         [ -function funcname [ -function funcname ...] ]\n";
 219     print "         [ -nofunction funcname [ -nofunction funcname ...] ]\n";
 220     print "         c source file(s) > outputfile\n";
 221     print "         -v : verbose output, more warnings & other info listed\n";
 222     exit 1;
 223 }
 224
 225 # read arguments
 226 if ($#ARGV==-1) {
 227     usage();
 228 }
 229
 230 my $verbose = 0;
 231 my $output_mode = "man";
 232 my $no_doc_sections = 0;
 233 my %highlights = %highlights_man;
 234 my $blankline = $blankline_man;
 235 my $modulename = "Kernel API";
 236 my $function_only = 0;
 237 my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
 238                 'July', 'August', 'September', 'October',
 239                 'November', 'December')[(localtime)[4]] .
 240   " " . ((localtime)[5]+1900);
 241
 242 # Essentially these are globals
 243 # They probably want to be tidied up made more localised or summat.
 244 # CAVEAT EMPTOR!  Some of the others I localised may not want to be which
 245 # could cause "use of undefined value" or other bugs.
 246 my ($function, %function_table,%parametertypes,$declaration_purpose);
 247 my ($type,$declaration_name,$return_type);
 248 my ($newsection,$newcontents,$prototype,$filelist, $brcount, %source_map);
 249
 250 # Generated docbook code is inserted in a template at a point where
 251 # docbook v3.1 requires a non-zero sequence of RefEntry's; see:
 252 # http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
 253 # We keep track of number of generated entries and generate a dummy
 254 # if needs be to ensure the expanded template can be postprocessed
 255 # into html.
 256 my $section_counter = 0;
 257
 258 my $lineprefix="";
 259
 260 # states
 261 # 0 - normal code
 262 # 1 - looking for function name
 263 # 2 - scanning field start.
 264 # 3 - scanning prototype.
 265 # 4 - documentation block
 266 my $state;
 267 my $in_doc_sect;
 268
 269 #declaration types: can be
 270 # 'function', 'struct', 'union', 'enum', 'typedef'
 271 my $decl_type;
 272
 273 my $doc_special = "\@\%\$\&";
 274
 275 my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
 276 my $doc_end = '\*/';
 277 my $doc_com = '\s*\*\s*';
 278 my $doc_decl = $doc_com.'(\w+)';
 279 my $doc_sect = $doc_com.'(['.$doc_special.']?[\w\s]+):(.*)';
 280 my $doc_content = $doc_com.'(.*)';
 281 my $doc_block = $doc_com.'DOC:\s*(.*)?';
 282
 283 my %constants;
 284 my %parameterdescs;
 285 my @parameterlist;
 286 my %sections;
 287 my @sectionlist;
 288
 289 my $contents = "";
 290 my $section_default = "Description";    # default section
 291 my $section_intro = "Introduction";
 292 my $section = $section_default;
 293 my $section_context = "Context";
 294
 295 my $undescribed = "-- undescribed --";
 296
 297 reset_state();
 298
 299 while ($ARGV[0] =~ m/^-(.*)/) {
 300     my $cmd = shift @ARGV;
 301     if ($cmd eq "-html") {
 302         $output_mode = "html";
 303         %highlights = %highlights_html;
 304         $blankline = $blankline_html;
 305     } elsif ($cmd eq "-man") {
 306         $output_mode = "man";
 307         %highlights = %highlights_man;
 308         $blankline = $blankline_man;
 309     } elsif ($cmd eq "-text") {
 310         $output_mode = "text";
 311         %highlights = %highlights_text;
 312         $blankline = $blankline_text;
 313     } elsif ($cmd eq "-docbook") {
 314         $output_mode = "xml";
 315         %highlights = %highlights_xml;
 316         $blankline = $blankline_xml;
 317     } elsif ($cmd eq "-gnome") {
 318         $output_mode = "gnome";
 319         %highlights = %highlights_gnome;
 320         $blankline = $blankline_gnome;
 321     } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document
 322         $modulename = shift @ARGV;
 323     } elsif ($cmd eq "-function") { # to only output specific functions
 324         $function_only = 1;
 325         $function = shift @ARGV;
 326         $function_table{$function} = 1;
 327     } elsif ($cmd eq "-nofunction") { # to only output specific functions
 328         $function_only = 2;
 329         $function = shift @ARGV;
 330         $function_table{$function} = 1;
 331     } elsif ($cmd eq "-v") {
 332         $verbose = 1;
 333     } elsif (($cmd eq "-h") || ($cmd eq "--help")) {
 334         usage();
 335     } elsif ($cmd eq '-filelist') {
 336             $filelist = shift @ARGV;
 337     } elsif ($cmd eq '-no-doc-sections') {
 338             $no_doc_sections = 1;
 339     }
 340 }
 341
 342 # get kernel version from env
 343 sub get_kernel_version() {
 344     my $version = 'unknown kernel version';
 345
 346     if (defined($ENV{'KERNELVERSION'})) {
 347         $version = $ENV{'KERNELVERSION'};
 348     }
 349     return $version;
 350 }
 351 my $kernelversion = get_kernel_version();
 352
 353 # generate a sequence of code that will splice in highlighting information
 354 # using the s// operator.
 355 my $dohighlight = "";
 356 foreach my $pattern (keys %highlights) {
 357 #   print STDERR "scanning pattern:$pattern, highlight:($highlights{$pattern})\n";
 358     $dohighlight .=  "\$contents =~ s:$pattern:$highlights{$pattern}:gs;\n";
 359 }
 360
 361 ##
 362 # dumps section contents to arrays/hashes intended for that purpose.
 363 #
 364 sub dump_section {
 365     my $name = shift;
 366     my $contents = join "\n", @_;
 367
 368     if ($name =~ m/$type_constant/) {
 369         $name = $1;
 370 #       print STDERR "constant section '$1' = '$contents'\n";
 371         $constants{$name} = $contents;
 372     } elsif ($name =~ m/$type_param/) {
 373 #       print STDERR "parameter def '$1' = '$contents'\n";
 374         $name = $1;
 375         $parameterdescs{$name} = $contents;
 376     } else {
 377 #       print STDERR "other section '$name' = '$contents'\n";
 378         $sections{$name} = $contents;
 379         push @sectionlist, $name;
 380     }
 381 }
 382
 383 ##
 384 # dump DOC: section after checking that it should go out
 385 #
 386 sub dump_doc_section {
 387     my $name = shift;
 388     my $contents = join "\n", @_;
 389
 390     if ($no_doc_sections) {
 391         return;
 392     }
 393
 394     if (($function_only == 0) ||
 395         ( $function_only == 1 && defined($function_table{$name})) ||
 396         ( $function_only == 2 && !defined($function_table{$name})))
 397     {
 398         dump_section $name, $contents;
 399         output_blockhead({'sectionlist' => \@sectionlist,
 400                           'sections' => \%sections,
 401                           'module' => $modulename,
 402                           'content-only' => ($function_only != 0), });
 403     }
 404 }
 405
 406 ##
 407 # output function
 408 #
 409 # parameterdescs, a hash.
 410 #  function => "function name"
 411 #  parameterlist => @list of parameters
 412 #  parameterdescs => %parameter descriptions
 413 #  sectionlist => @list of sections
 414 #  sections => %section descriptions
 415 #
 416
 417 sub output_highlight {
 418     my $contents = join "\n",@_;
 419     my $line;
 420
 421 #   DEBUG
 422 #   if (!defined $contents) {
 423 #       use Carp;
 424 #       confess "output_highlight got called with no args?\n";
 425 #   }
 426
 427     if ($output_mode eq "html" || $output_mode eq "xml") {
 428         $contents = local_unescape($contents);
 429         # convert data read & converted thru xml_escape() into &xyz; format:
 430         $contents =~ s/\\\\\\/&/g;
 431     }
 432 #   print STDERR "contents b4:$contents\n";
 433     eval $dohighlight;
 434     die $@ if $@;
 435 #   print STDERR "contents af:$contents\n";
 436
 437     foreach $line (split "\n", $contents) {
 438         if ($line eq ""){
 439             print $lineprefix, local_unescape($blankline);
 440         } else {
 441             $line =~ s/\\\\\\/\&/g;
 442             if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
 443                 print "\\&$line";
 444             } else {
 445                 print $lineprefix, $line;
 446             }
 447         }
 448         print "\n";
 449     }
 450 }
 451
 452 #output sections in html
 453 sub output_section_html(%) {
 454     my %args = %{$_[0]};
 455     my $section;
 456
 457     foreach $section (@{$args{'sectionlist'}}) {
 458         print "<h3>$section</h3>\n";
 459         print "<blockquote>\n";
 460         output_highlight($args{'sections'}{$section});
 461         print "</blockquote>\n";
 462     }
 463 }
 464
 465 # output enum in html
 466 sub output_enum_html(%) {
 467     my %args = %{$_[0]};
 468     my ($parameter);
 469     my $count;
 470     print "<h2>enum ".$args{'enum'}."</h2>\n";
 471
 472     print "<b>enum ".$args{'enum'}."</b> {<br>\n";
 473     $count = 0;
 474     foreach $parameter (@{$args{'parameterlist'}}) {
 475         print " <b>".$parameter."</b>";
 476         if ($count != $#{$args{'parameterlist'}}) {
 477             $count++;
 478             print ",\n";
 479         }
 480         print "<br>";
 481     }
 482     print "};<br>\n";
 483
 484     print "<h3>Constants</h3>\n";
 485     print "<dl>\n";
 486     foreach $parameter (@{$args{'parameterlist'}}) {
 487         print "<dt><b>".$parameter."</b>\n";
 488         print "<dd>";
 489         output_highlight($args{'parameterdescs'}{$parameter});
 490     }
 491     print "</dl>\n";
 492     output_section_html(@_);
 493     print "<hr>\n";
 494 }
 495
 496 # output typedef in html
 497 sub output_typedef_html(%) {
 498     my %args = %{$_[0]};
 499     my ($parameter);
 500     my $count;
 501     print "<h2>typedef ".$args{'typedef'}."</h2>\n";
 502
 503     print "<b>typedef ".$args{'typedef'}."</b>\n";
 504     output_section_html(@_);
 505     print "<hr>\n";
 506 }
 507
 508 # output struct in html
 509 sub output_struct_html(%) {
 510     my %args = %{$_[0]};
 511     my ($parameter);
 512
 513     print "<h2>".$args{'type'}." ".$args{'struct'}. " - " .$args{'purpose'}."</h2>\n";
 514     print "<b>".$args{'type'}." ".$args{'struct'}."</b> {<br>\n";
 515     foreach $parameter (@{$args{'parameterlist'}}) {
 516         if ($parameter =~ /^#/) {
 517                 print "$parameter<br>\n";
 518                 next;
 519         }
 520         my $parameter_name = $parameter;
 521         $parameter_name =~ s/\[.*//;
 522
 523         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
 524         $type = $args{'parametertypes'}{$parameter};
 525         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
 526             # pointer-to-function
 527             print "&nbsp; &nbsp; <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>\n";
 528         } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
 529             # bitfield
 530             print "&nbsp; &nbsp; <i>$1</i> <b>$parameter</b>$2;<br>\n";
 531         } else {
 532             print "&nbsp; &nbsp; <i>$type</i> <b>$parameter</b>;<br>\n";
 533         }
 534     }
 535     print "};<br>\n";
 536
 537     print "<h3>Members</h3>\n";
 538     print "<dl>\n";
 539     foreach $parameter (@{$args{'parameterlist'}}) {
 540         ($parameter =~ /^#/) && next;
 541
 542         my $parameter_name = $parameter;
 543         $parameter_name =~ s/\[.*//;
 544
 545         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
 546         print "<dt><b>".$parameter."</b>\n";
 547         print "<dd>";
 548         output_highlight($args{'parameterdescs'}{$parameter_name});
 549     }
 550     print "</dl>\n";
 551     output_section_html(@_);
 552     print "<hr>\n";
 553 }
 554
 555 # output function in html
 556 sub output_function_html(%) {
 557     my %args = %{$_[0]};
 558     my ($parameter, $section);
 559     my $count;
 560
 561     print "<h2>" .$args{'function'}." - ".$args{'purpose'}."</h2>\n";
 562     print "<i>".$args{'functiontype'}."</i>\n";
 563     print "<b>".$args{'function'}."</b>\n";
 564     print "(";
 565     $count = 0;
 566     foreach $parameter (@{$args{'parameterlist'}}) {
 567         $type = $args{'parametertypes'}{$parameter};
 568         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
 569             # pointer-to-function
 570             print "<i>$1</i><b>$parameter</b>) <i>($2)</i>";
 571         } else {
 572             print "<i>".$type."</i> <b>".$parameter."</b>";
 573         }
 574         if ($count != $#{$args{'parameterlist'}}) {
 575             $count++;
 576             print ",\n";
 577         }
 578     }
 579     print ")\n";
 580
 581     print "<h3>Arguments</h3>\n";
 582     print "<dl>\n";
 583     foreach $parameter (@{$args{'parameterlist'}}) {
 584         my $parameter_name = $parameter;
 585         $parameter_name =~ s/\[.*//;
 586
 587         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
 588         print "<dt><b>".$parameter."</b>\n";
 589         print "<dd>";
 590         output_highlight($args{'parameterdescs'}{$parameter_name});
 591     }
 592     print "</dl>\n";
 593     output_section_html(@_);
 594     print "<hr>\n";
 595 }
 596
 597 # output DOC: block header in html
 598 sub output_blockhead_html(%) {
 599     my %args = %{$_[0]};
 600     my ($parameter, $section);
 601     my $count;
 602
 603     foreach $section (@{$args{'sectionlist'}}) {
 604         print "<h3>$section</h3>\n";
 605         print "<ul>\n";
 606         output_highlight($args{'sections'}{$section});
 607         print "</ul>\n";
 608     }
 609     print "<hr>\n";
 610 }
 611
 612 sub output_section_xml(%) {
 613     my %args = %{$_[0]};
 614     my $section;
 615     # print out each section
 616     $lineprefix="   ";
 617     foreach $section (@{$args{'sectionlist'}}) {
 618         print "<refsect1>\n";
 619         print "<title>$section</title>\n";
 620         if ($section =~ m/EXAMPLE/i) {
 621             print "<informalexample><programlisting>\n";
 622         } else {
 623             print "<para>\n";
 624         }
 625         output_highlight($args{'sections'}{$section});
 626         if ($section =~ m/EXAMPLE/i) {
 627             print "</programlisting></informalexample>\n";
 628         } else {
 629             print "</para>\n";
 630         }
 631         print "</refsect1>\n";
 632     }
 633 }
 634
 635 # output function in XML DocBook
 636 sub output_function_xml(%) {
 637     my %args = %{$_[0]};
 638     my ($parameter, $section);
 639     my $count;
 640     my $id;
 641
 642     $id = "API-".$args{'function'};
 643     $id =~ s/[^A-Za-z0-9]/-/g;
 644
 645     print "<refentry id=\"$id\">\n";
 646     print "<refentryinfo>\n";
 647     print " <title>LINUX</title>\n";
 648     print " <productname>Kernel Hackers Manual</productname>\n";
 649     print " <date>$man_date</date>\n";
 650     print "</refentryinfo>\n";
 651     print "<refmeta>\n";
 652     print " <refentrytitle><phrase>".$args{'function'}."</phrase></refentrytitle>\n";
 653     print " <manvolnum>9</manvolnum>\n";
 654     print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
 655     print "</refmeta>\n";
 656     print "<refnamediv>\n";
 657     print " <refname>".$args{'function'}."</refname>\n";
 658     print " <refpurpose>\n";
 659     print "  ";
 660     output_highlight ($args{'purpose'});
 661     print " </refpurpose>\n";
 662     print "</refnamediv>\n";
 663
 664     print "<refsynopsisdiv>\n";
 665     print " <title>Synopsis</title>\n";
 666     print "  <funcsynopsis><funcprototype>\n";
 667     print "   <funcdef>".$args{'functiontype'}." ";
 668     print "<function>".$args{'function'}." </function></funcdef>\n";
 669
 670     $count = 0;
 671     if ($#{$args{'parameterlist'}} >= 0) {
 672         foreach $parameter (@{$args{'parameterlist'}}) {
 673             $type = $args{'parametertypes'}{$parameter};
 674             if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
 675                 # pointer-to-function
 676                 print "   <paramdef>$1<parameter>$parameter</parameter>)\n";
 677                 print "     <funcparams>$2</funcparams></paramdef>\n";
 678             } else {
 679                 print "   <paramdef>".$type;
 680                 print " <parameter>$parameter</parameter></paramdef>\n";
 681             }
 682         }
 683     } else {
 684         print "  <void/>\n";
 685     }
 686     print "  </funcprototype></funcsynopsis>\n";
 687     print "</refsynopsisdiv>\n";
 688
 689     # print parameters
 690     print "<refsect1>\n <title>Arguments</title>\n";
 691     if ($#{$args{'parameterlist'}} >= 0) {
 692         print " <variablelist>\n";
 693         foreach $parameter (@{$args{'parameterlist'}}) {
 694             my $parameter_name = $parameter;
 695             $parameter_name =~ s/\[.*//;
 696
 697             print "  <varlistentry>\n   <term><parameter>$parameter</parameter></term>\n";
 698             print "   <listitem>\n    <para>\n";
 699             $lineprefix="     ";
 700             output_highlight($args{'parameterdescs'}{$parameter_name});
 701             print "    </para>\n   </listitem>\n  </varlistentry>\n";
 702         }
 703         print " </variablelist>\n";
 704     } else {
 705         print " <para>\n  None\n </para>\n";
 706     }
 707     print "</refsect1>\n";
 708
 709     output_section_xml(@_);
 710     print "</refentry>\n\n";
 711 }
 712
 713 # output struct in XML DocBook
 714 sub output_struct_xml(%) {
 715     my %args = %{$_[0]};
 716     my ($parameter, $section);
 717     my $id;
 718
 719     $id = "API-struct-".$args{'struct'};
 720     $id =~ s/[^A-Za-z0-9]/-/g;
 721
 722     print "<refentry id=\"$id\">\n";
 723     print "<refentryinfo>\n";
 724     print " <title>LINUX</title>\n";
 725     print " <productname>Kernel Hackers Manual</productname>\n";
 726     print " <date>$man_date</date>\n";
 727     print "</refentryinfo>\n";
 728     print "<refmeta>\n";
 729     print " <refentrytitle><phrase>".$args{'type'}." ".$args{'struct'}."</phrase></refentrytitle>\n";
 730     print " <manvolnum>9</manvolnum>\n";
 731     print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
 732     print "</refmeta>\n";
 733     print "<refnamediv>\n";
 734     print " <refname>".$args{'type'}." ".$args{'struct'}."</refname>\n";
 735     print " <refpurpose>\n";
 736     print "  ";
 737     output_highlight ($args{'purpose'});
 738     print " </refpurpose>\n";
 739     print "</refnamediv>\n";
 740
 741     print "<refsynopsisdiv>\n";
 742     print " <title>Synopsis</title>\n";
 743     print "  <programlisting>\n";
 744     print $args{'type'}." ".$args{'struct'}." {\n";
 745     foreach $parameter (@{$args{'parameterlist'}}) {
 746         if ($parameter =~ /^#/) {
 747             print "$parameter\n";
 748             next;
 749         }
 750
 751         my $parameter_name = $parameter;
 752         $parameter_name =~ s/\[.*//;
 753
 754         defined($args{'parameterdescs'}{$parameter_name}) || next;
 755         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
 756         $type = $args{'parametertypes'}{$parameter};
 757         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
 758             # pointer-to-function
 759             print "  $1 $parameter) ($2);\n";
 760         } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
 761             # bitfield
 762             print "  $1 $parameter$2;\n";
 763         } else {
 764             print "  ".$type." ".$parameter.";\n";
 765         }
 766     }
 767     print "};";
 768     print "  </programlisting>\n";
 769     print "</refsynopsisdiv>\n";
 770
 771     print " <refsect1>\n";
 772     print "  <title>Members</title>\n";
 773
 774     print "  <variablelist>\n";
 775     foreach $parameter (@{$args{'parameterlist'}}) {
 776       ($parameter =~ /^#/) && next;
 777
 778       my $parameter_name = $parameter;
 779       $parameter_name =~ s/\[.*//;
 780
 781       defined($args{'parameterdescs'}{$parameter_name}) || next;
 782       ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
 783       print "    <varlistentry>";
 784       print "      <term>$parameter</term>\n";
 785       print "      <listitem><para>\n";
 786       output_highlight($args{'parameterdescs'}{$parameter_name});
 787       print "      </para></listitem>\n";
 788       print "    </varlistentry>\n";
 789     }
 790     print "  </variablelist>\n";
 791     print " </refsect1>\n";
 792
 793     output_section_xml(@_);
 794
 795     print "</refentry>\n\n";
 796 }
 797
 798 # output enum in XML DocBook
 799 sub output_enum_xml(%) {
 800     my %args = %{$_[0]};
 801     my ($parameter, $section);
 802     my $count;
 803     my $id;
 804
 805     $id = "API-enum-".$args{'enum'};
 806     $id =~ s/[^A-Za-z0-9]/-/g;
 807
 808     print "<refentry id=\"$id\">\n";
 809     print "<refentryinfo>\n";
 810     print " <title>LINUX</title>\n";
 811     print " <productname>Kernel Hackers Manual</productname>\n";
 812     print " <date>$man_date</date>\n";
 813     print "</refentryinfo>\n";
 814     print "<refmeta>\n";
 815     print " <refentrytitle><phrase>enum ".$args{'enum'}."</phrase></refentrytitle>\n";
 816     print " <manvolnum>9</manvolnum>\n";
 817     print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>\n";
 818     print "</refmeta>\n";
 819     print "<refnamediv>\n";
 820     print " <refname>enum ".$args{'enum'}."</refname>\n";
 821     print " <refpurpose>\n";
 822     print "  ";
 823     output_highlight ($args{'purpose'});
 824     print " </refpurpose>\n";
 825     print "</refnamediv>\n";
 826
 827     print "<refsynopsisdiv>\n";
 828     print " <title>Synopsis</title>\n";
 829     print "  <programlisting>\n";
 830     print "enum ".$args{'enum'}." {\n";
 831     $count = 0;
 832     foreach $parameter (@{$args{'parameterlist'}}) {
 833         print "  $parameter";
 834         if ($count != $#{$args{'parameterlist'}}) {
 835             $count++;
 836             print ",";
 837         }
 838         print "\n";
 839     }
 840     print "};";
 841     print "  </programlisting>\n";
 842     print "</refsynopsisdiv>\n";
 843
 844     print "<refsect1>\n";
 845     print " <title>Constants</title>\n";
 846     print "  <variablelist>\n";
 847     foreach $parameter (@{$args{'parameterlist'}}) {
 848       my $parameter_name = $parameter;
 849       $parameter_name =~ s/\[.*//;
 850
 851       print "    <varlistentry>";
 852       print "      <term>$parameter</term>\n";
 853       print "      <listitem><para>\n";
 854       output_highlight($args{'parameterdescs'}{$parameter_name});
 855       print "      </para></listitem>\n";
 856       print "    </varlistentry>\n";
 857     }
 858     print "  </variablelist>\n";
 859     print "</refsect1>\n";
 860
 861     output_section_xml(@_);
 862
 863     print "</refentry>\n\n";
 864 }
 865
 866 # output typedef in XML DocBook
 867 sub output_typedef_xml(%) {
 868     my %args = %{$_[0]};
 869     my ($parameter, $section);
 870     my $id;
 871
 872     $id = "API-typedef-".$args{'typedef'};
 873     $id =~ s/[^A-Za-z0-9]/-/g;
 874
 875     print "<refentry id=\"$id\">\n";
 876     print "<refentryinfo>\n";
 877     print " <title>LINUX</title>\n";
 878     print " <productname>Kernel Hackers Manual</productname>\n";
 879     print " <date>$man_date</date>\n";
 880     print "</refentryinfo>\n";
 881     print "<refmeta>\n";
 882     print " <refentrytitle><phrase>typedef ".$args{'typedef'}."</phrase></refentrytitle>\n";
 883     print " <manvolnum>9</manvolnum>\n";
 884     print "</refmeta>\n";
 885     print "<refnamediv>\n";
 886     print " <refname>typedef ".$args{'typedef'}."</refname>\n";
 887     print " <refpurpose>\n";
 888     print "  ";
 889     output_highlight ($args{'purpose'});
 890     print " </refpurpose>\n";
 891     print "</refnamediv>\n";
 892
 893     print "<refsynopsisdiv>\n";
 894     print " <title>Synopsis</title>\n";
 895     print "  <synopsis>typedef ".$args{'typedef'}.";</synopsis>\n";
 896     print "</refsynopsisdiv>\n";
 897
 898     output_section_xml(@_);
 899
 900     print "</refentry>\n\n";
 901 }
 902
 903 # output in XML DocBook
 904 sub output_blockhead_xml(%) {
 905     my %args = %{$_[0]};
 906     my ($parameter, $section);
 907     my $count;
 908
 909     my $id = $args{'module'};
 910     $id =~ s/[^A-Za-z0-9]/-/g;
 911
 912     # print out each section
 913     $lineprefix="   ";
 914     foreach $section (@{$args{'sectionlist'}}) {
 915         if (!$args{'content-only'}) {
 916                 print "<refsect1>\n <title>$section</title>\n";
 917         }
 918         if ($section =~ m/EXAMPLE/i) {
 919             print "<example><para>\n";
 920         } else {
 921             print "<para>\n";
 922         }
 923         output_highlight($args{'sections'}{$section});
 924         if ($section =~ m/EXAMPLE/i) {
 925             print "</para></example>\n";
 926         } else {
 927             print "</para>";
 928         }
 929         if (!$args{'content-only'}) {
 930                 print "\n</refsect1>\n";
 931         }
 932     }
 933
 934     print "\n\n";
 935 }
 936
 937 # output in XML DocBook
 938 sub output_function_gnome {
 939     my %args = %{$_[0]};
 940     my ($parameter, $section);
 941     my $count;
 942     my $id;
 943
 944     $id = $args{'module'}."-".$args{'function'};
 945     $id =~ s/[^A-Za-z0-9]/-/g;
 946
 947     print "<sect2>\n";
 948     print " <title id=\"$id\">".$args{'function'}."</title>\n";
 949
 950     print "  <funcsynopsis>\n";
 951     print "   <funcdef>".$args{'functiontype'}." ";
 952     print "<function>".$args{'function'}." ";
 953     print "</function></funcdef>\n";
 954
 955     $count = 0;
 956     if ($#{$args{'parameterlist'}} >= 0) {
 957         foreach $parameter (@{$args{'parameterlist'}}) {
 958             $type = $args{'parametertypes'}{$parameter};
 959             if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
 960                 # pointer-to-function
 961                 print "   <paramdef>$1 <parameter>$parameter</parameter>)\n";
 962                 print "     <funcparams>$2</funcparams></paramdef>\n";
 963             } else {
 964                 print "   <paramdef>".$type;
 965                 print " <parameter>$parameter</parameter></paramdef>\n";
 966             }
 967         }
 968     } else {
 969         print "  <void>\n";
 970     }
 971     print "  </funcsynopsis>\n";
 972     if ($#{$args{'parameterlist'}} >= 0) {
 973         print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">\n";
 974         print "<tgroup cols=\"2\">\n";
 975         print "<colspec colwidth=\"2*\">\n";
 976         print "<colspec colwidth=\"8*\">\n";
 977         print "<tbody>\n";
 978         foreach $parameter (@{$args{'parameterlist'}}) {
 979             my $parameter_name = $parameter;
 980             $parameter_name =~ s/\[.*//;
 981
 982             print "  <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n";
 983             print "   <entry>\n";
 984             $lineprefix="     ";
 985             output_highlight($args{'parameterdescs'}{$parameter_name});
 986             print "    </entry></row>\n";
 987         }
 988         print " </tbody></tgroup></informaltable>\n";
 989     } else {
 990         print " <para>\n  None\n </para>\n";
 991     }
 992
 993     # print out each section
 994     $lineprefix="   ";
 995     foreach $section (@{$args{'sectionlist'}}) {
 996         print "<simplesect>\n <title>$section</title>\n";
 997         if ($section =~ m/EXAMPLE/i) {
 998             print "<example><programlisting>\n";
 999         } else {
1000         }
1001         print "<para>\n";
1002         output_highlight($args{'sections'}{$section});
1003         print "</para>\n";
1004         if ($section =~ m/EXAMPLE/i) {
1005             print "</programlisting></example>\n";
1006         } else {
1007         }
1008         print " </simplesect>\n";
1009     }
1010
1011     print "</sect2>\n\n";
1012 }
1013
1014 ##
1015 # output function in man
1016 sub output_function_man(%) {
1017     my %args = %{$_[0]};
1018     my ($parameter, $section);
1019     my $count;
1020
1021     print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
1022
1023     print ".SH NAME\n";
1024     print $args{'function'}." \\- ".$args{'purpose'}."\n";
1025
1026     print ".SH SYNOPSIS\n";
1027     if ($args{'functiontype'} ne "") {
1028         print ".B \"".$args{'functiontype'}."\" ".$args{'function'}."\n";
1029     } else {
1030         print ".B \"".$args{'function'}."\n";
1031     }
1032     $count = 0;
1033     my $parenth = "(";
1034     my $post = ",";
1035     foreach my $parameter (@{$args{'parameterlist'}}) {
1036         if ($count == $#{$args{'parameterlist'}}) {
1037             $post = ");";
1038         }
1039         $type = $args{'parametertypes'}{$parameter};
1040         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1041             # pointer-to-function
1042             print ".BI \"".$parenth.$1."\" ".$parameter." \") (".$2.")".$post."\"\n";
1043         } else {
1044             $type =~ s/([^\*])$/$1 /;
1045             print ".BI \"".$parenth.$type."\" ".$parameter." \"".$post."\"\n";
1046         }
1047         $count++;
1048         $parenth = "";
1049     }
1050
1051     print ".SH ARGUMENTS\n";
1052     foreach $parameter (@{$args{'parameterlist'}}) {
1053         my $parameter_name = $parameter;
1054         $parameter_name =~ s/\[.*//;
1055
1056         print ".IP \"".$parameter."\" 12\n";
1057         output_highlight($args{'parameterdescs'}{$parameter_name});
1058     }
1059     foreach $section (@{$args{'sectionlist'}}) {
1060         print ".SH \"", uc $section, "\"\n";
1061         output_highlight($args{'sections'}{$section});
1062     }
1063 }
1064
1065 ##
1066 # output enum in man
1067 sub output_enum_man(%) {
1068     my %args = %{$_[0]};
1069     my ($parameter, $section);
1070     my $count;
1071
1072     print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
1073
1074     print ".SH NAME\n";
1075     print "enum ".$args{'enum'}." \\- ".$args{'purpose'}."\n";
1076
1077     print ".SH SYNOPSIS\n";
1078     print "enum ".$args{'enum'}." {\n";
1079     $count = 0;
1080     foreach my $parameter (@{$args{'parameterlist'}}) {
1081         print ".br\n.BI \"    $parameter\"\n";
1082         if ($count == $#{$args{'parameterlist'}}) {
1083             print "\n};\n";
1084             last;
1085         }
1086         else {
1087             print ", \n.br\n";
1088         }
1089         $count++;
1090     }
1091
1092     print ".SH Constants\n";
1093     foreach $parameter (@{$args{'parameterlist'}}) {
1094         my $parameter_name = $parameter;
1095         $parameter_name =~ s/\[.*//;
1096
1097         print ".IP \"".$parameter."\" 12\n";
1098         output_highlight($args{'parameterdescs'}{$parameter_name});
1099     }
1100     foreach $section (@{$args{'sectionlist'}}) {
1101         print ".SH \"$section\"\n";
1102         output_highlight($args{'sections'}{$section});
1103     }
1104 }
1105
1106 ##
1107 # output struct in man
1108 sub output_struct_man(%) {
1109     my %args = %{$_[0]};
1110     my ($parameter, $section);
1111
1112     print ".TH \"$args{'module'}\" 9 \"".$args{'type'}." ".$args{'struct'}."\" \"$man_date\" \"API Manual\" LINUX\n";
1113
1114     print ".SH NAME\n";
1115     print $args{'type'}." ".$args{'struct'}." \\- ".$args{'purpose'}."\n";
1116
1117     print ".SH SYNOPSIS\n";
1118     print $args{'type'}." ".$args{'struct'}." {\n.br\n";
1119
1120     foreach my $parameter (@{$args{'parameterlist'}}) {
1121         if ($parameter =~ /^#/) {
1122             print ".BI \"$parameter\"\n.br\n";
1123             next;
1124         }
1125         my $parameter_name = $parameter;
1126         $parameter_name =~ s/\[.*//;
1127
1128         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1129         $type = $args{'parametertypes'}{$parameter};
1130         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1131             # pointer-to-function
1132             print ".BI \"    ".$1."\" ".$parameter." \") (".$2.")"."\"\n;\n";
1133         } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1134             # bitfield
1135             print ".BI \"    ".$1."\ \" ".$parameter.$2." \""."\"\n;\n";
1136         } else {
1137             $type =~ s/([^\*])$/$1 /;
1138             print ".BI \"    ".$type."\" ".$parameter." \""."\"\n;\n";
1139         }
1140         print "\n.br\n";
1141     }
1142     print "};\n.br\n";
1143
1144     print ".SH Members\n";
1145     foreach $parameter (@{$args{'parameterlist'}}) {
1146         ($parameter =~ /^#/) && next;
1147
1148         my $parameter_name = $parameter;
1149         $parameter_name =~ s/\[.*//;
1150
1151         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1152         print ".IP \"".$parameter."\" 12\n";
1153         output_highlight($args{'parameterdescs'}{$parameter_name});
1154     }
1155     foreach $section (@{$args{'sectionlist'}}) {
1156         print ".SH \"$section\"\n";
1157         output_highlight($args{'sections'}{$section});
1158     }
1159 }
1160
1161 ##
1162 # output typedef in man
1163 sub output_typedef_man(%) {
1164     my %args = %{$_[0]};
1165     my ($parameter, $section);
1166
1167     print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
1168
1169     print ".SH NAME\n";
1170     print "typedef ".$args{'typedef'}." \\- ".$args{'purpose'}."\n";
1171
1172     foreach $section (@{$args{'sectionlist'}}) {
1173         print ".SH \"$section\"\n";
1174         output_highlight($args{'sections'}{$section});
1175     }
1176 }
1177
1178 sub output_blockhead_man(%) {
1179     my %args = %{$_[0]};
1180     my ($parameter, $section);
1181     my $count;
1182
1183     print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
1184
1185     foreach $section (@{$args{'sectionlist'}}) {
1186         print ".SH \"$section\"\n";
1187         output_highlight($args{'sections'}{$section});
1188     }
1189 }
1190
1191 ##
1192 # output in text
1193 sub output_function_text(%) {
1194     my %args = %{$_[0]};
1195     my ($parameter, $section);
1196     my $start;
1197
1198     print "Name:\n\n";
1199     print $args{'function'}." - ".$args{'purpose'}."\n";
1200
1201     print "\nSynopsis:\n\n";
1202     if ($args{'functiontype'} ne "") {
1203         $start = $args{'functiontype'}." ".$args{'function'}." (";
1204     } else {
1205         $start = $args{'function'}." (";
1206     }
1207     print $start;
1208
1209     my $count = 0;
1210     foreach my $parameter (@{$args{'parameterlist'}}) {
1211         $type = $args{'parametertypes'}{$parameter};
1212         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1213             # pointer-to-function
1214             print $1.$parameter.") (".$2;
1215         } else {
1216             print $type." ".$parameter;
1217         }
1218         if ($count != $#{$args{'parameterlist'}}) {
1219             $count++;
1220             print ",\n";
1221             print " " x length($start);
1222         } else {
1223             print ");\n\n";
1224         }
1225     }
1226
1227     print "Arguments:\n\n";
1228     foreach $parameter (@{$args{'parameterlist'}}) {
1229         my $parameter_name = $parameter;
1230         $parameter_name =~ s/\[.*//;
1231
1232         print $parameter."\n\t".$args{'parameterdescs'}{$parameter_name}."\n";
1233     }
1234     output_section_text(@_);
1235 }
1236
1237 #output sections in text
1238 sub output_section_text(%) {
1239     my %args = %{$_[0]};
1240     my $section;
1241
1242     print "\n";
1243     foreach $section (@{$args{'sectionlist'}}) {
1244         print "$section:\n\n";
1245         output_highlight($args{'sections'}{$section});
1246     }
1247     print "\n\n";
1248 }
1249
1250 # output enum in text
1251 sub output_enum_text(%) {
1252     my %args = %{$_[0]};
1253     my ($parameter);
1254     my $count;
1255     print "Enum:\n\n";
1256
1257     print "enum ".$args{'enum'}." - ".$args{'purpose'}."\n\n";
1258     print "enum ".$args{'enum'}." {\n";
1259     $count = 0;
1260     foreach $parameter (@{$args{'parameterlist'}}) {
1261         print "\t$parameter";
1262         if ($count != $#{$args{'parameterlist'}}) {
1263             $count++;
1264             print ",";
1265         }
1266         print "\n";
1267     }
1268     print "};\n\n";
1269
1270     print "Constants:\n\n";
1271     foreach $parameter (@{$args{'parameterlist'}}) {
1272         print "$parameter\n\t";
1273         print $args{'parameterdescs'}{$parameter}."\n";
1274     }
1275
1276     output_section_text(@_);
1277 }
1278
1279 # output typedef in text
1280 sub output_typedef_text(%) {
1281     my %args = %{$_[0]};
1282     my ($parameter);
1283     my $count;
1284     print "Typedef:\n\n";
1285
1286     print "typedef ".$args{'typedef'}." - ".$args{'purpose'}."\n";
1287     output_section_text(@_);
1288 }
1289
1290 # output struct as text
1291 sub output_struct_text(%) {
1292     my %args = %{$_[0]};
1293     my ($parameter);
1294
1295     print $args{'type'}." ".$args{'struct'}." - ".$args{'purpose'}."\n\n";
1296     print $args{'type'}." ".$args{'struct'}." {\n";
1297     foreach $parameter (@{$args{'parameterlist'}}) {
1298         if ($parameter =~ /^#/) {
1299             print "$parameter\n";
1300             next;
1301         }
1302
1303         my $parameter_name = $parameter;
1304         $parameter_name =~ s/\[.*//;
1305
1306         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1307         $type = $args{'parametertypes'}{$parameter};
1308         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
1309             # pointer-to-function
1310             print "\t$1 $parameter) ($2);\n";
1311         } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
1312             # bitfield
1313             print "\t$1 $parameter$2;\n";
1314         } else {
1315             print "\t".$type." ".$parameter.";\n";
1316         }
1317     }
1318     print "};\n\n";
1319
1320     print "Members:\n\n";
1321     foreach $parameter (@{$args{'parameterlist'}}) {
1322         ($parameter =~ /^#/) && next;
1323
1324         my $parameter_name = $parameter;
1325         $parameter_name =~ s/\[.*//;
1326
1327         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1328         print "$parameter\n\t";
1329         print $args{'parameterdescs'}{$parameter_name}."\n";
1330     }
1331     print "\n";
1332     output_section_text(@_);
1333 }
1334
1335 sub output_blockhead_text(%) {
1336     my %args = %{$_[0]};
1337     my ($parameter, $section);
1338
1339     foreach $section (@{$args{'sectionlist'}}) {
1340         print " $section:\n";
1341         print "    -> ";
1342         output_highlight($args{'sections'}{$section});
1343     }
1344 }
1345
1346 ##
1347 # generic output function for all types (function, struct/union, typedef, enum);
1348 # calls the generated, variable output_ function name based on
1349 # functype and output_mode
1350 sub output_declaration {
1351     no strict 'refs';
1352     my $name = shift;
1353     my $functype = shift;
1354     my $func = "output_${functype}_$output_mode";
1355     if (($function_only==0) ||
1356         ( $function_only == 1 && defined($function_table{$name})) ||
1357         ( $function_only == 2 && !defined($function_table{$name})))
1358     {
1359         &$func(@_);
1360         $section_counter++;
1361     }
1362 }
1363
1364 ##
1365 # generic output function - calls the right one based on current output mode.
1366 sub output_blockhead {
1367     no strict 'refs';
1368     my $func = "output_blockhead_".$output_mode;
1369     &$func(@_);
1370     $section_counter++;
1371 }
1372
1373 ##
1374 # takes a declaration (struct, union, enum, typedef) and
1375 # invokes the right handler. NOT called for functions.
1376 sub dump_declaration($$) {
1377     no strict 'refs';
1378     my ($prototype, $file) = @_;
1379     my $func = "dump_".$decl_type;
1380     &$func(@_);
1381 }
1382
1383 sub dump_union($$) {
1384     dump_struct(@_);
1385 }
1386
1387 sub dump_struct($$) {
1388     my $x = shift;
1389     my $file = shift;
1390
1391     if ($x =~/(struct|union)\s+(\w+)\s*{(.*)}/) {
1392         $declaration_name = $2;
1393         my $members = $3;
1394
1395         # ignore embedded structs or unions
1396         $members =~ s/{.*?}//g;
1397
1398         # ignore members marked private:
1399         $members =~ s/\/\*.*?private:.*?public:.*?\*\///gos;
1400         $members =~ s/\/\*.*?private:.*//gos;
1401         # strip comments:
1402         $members =~ s/\/\*.*?\*\///gos;
1403
1404         create_parameterlist($members, ';', $file);
1405
1406         output_declaration($declaration_name,
1407                            'struct',
1408                            {'struct' => $declaration_name,
1409                             'module' => $modulename,
1410                             'parameterlist' => \@parameterlist,
1411                             'parameterdescs' => \%parameterdescs,
1412                             'parametertypes' => \%parametertypes,
1413                             'sectionlist' => \@sectionlist,
1414                             'sections' => \%sections,
1415                             'purpose' => $declaration_purpose,
1416                             'type' => $decl_type
1417                            });
1418     }
1419     else {
1420         print STDERR "Error(${file}:$.): Cannot parse struct or union!\n";
1421         ++$errors;
1422     }
1423 }
1424
1425 sub dump_enum($$) {
1426     my $x = shift;
1427     my $file = shift;
1428
1429     $x =~ s@/\*.*?\*/@@gos;     # strip comments.
1430     if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
1431         $declaration_name = $1;
1432         my $members = $2;
1433
1434         foreach my $arg (split ',', $members) {
1435             $arg =~ s/^\s*(\w+).*/$1/;
1436             push @parameterlist, $arg;
1437             if (!$parameterdescs{$arg}) {
1438                 $parameterdescs{$arg} = $undescribed;
1439                 print STDERR "Warning(${file}:$.): Enum value '$arg' ".
1440                     "not described in enum '$declaration_name'\n";
1441             }
1442
1443         }
1444
1445         output_declaration($declaration_name,
1446                            'enum',
1447                            {'enum' => $declaration_name,
1448                             'module' => $modulename,
1449                             'parameterlist' => \@parameterlist,
1450                             'parameterdescs' => \%parameterdescs,
1451                             'sectionlist' => \@sectionlist,
1452                             'sections' => \%sections,
1453                             'purpose' => $declaration_purpose
1454                            });
1455     }
1456     else {
1457         print STDERR "Error(${file}:$.): Cannot parse enum!\n";
1458         ++$errors;
1459     }
1460 }
1461
1462 sub dump_typedef($$) {
1463     my $x = shift;
1464     my $file = shift;
1465
1466     $x =~ s@/\*.*?\*/@@gos;     # strip comments.
1467     while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1468         $x =~ s/\(*.\)\s*;$/;/;
1469         $x =~ s/\[*.\]\s*;$/;/;
1470     }
1471
1472     if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1473         $declaration_name = $1;
1474
1475         output_declaration($declaration_name,
1476                            'typedef',
1477                            {'typedef' => $declaration_name,
1478                             'module' => $modulename,
1479                             'sectionlist' => \@sectionlist,
1480                             'sections' => \%sections,
1481                             'purpose' => $declaration_purpose
1482                            });
1483     }
1484     else {
1485         print STDERR "Error(${file}:$.): Cannot parse typedef!\n";
1486         ++$errors;
1487     }
1488 }
1489
1490 sub create_parameterlist($$$) {
1491     my $args = shift;
1492     my $splitter = shift;
1493     my $file = shift;
1494     my $type;
1495     my $param;
1496
1497     # temporarily replace commas inside function pointer definition
1498     while ($args =~ /(\([^\),]+),/) {
1499         $args =~ s/(\([^\),]+),/$1#/g;
1500     }
1501
1502     foreach my $arg (split($splitter, $args)) {
1503         # strip comments
1504         $arg =~ s/\/\*.*\*\///;
1505         # strip leading/trailing spaces
1506         $arg =~ s/^\s*//;
1507         $arg =~ s/\s*$//;
1508         $arg =~ s/\s+/ /;
1509
1510         if ($arg =~ /^#/) {
1511             # Treat preprocessor directive as a typeless variable just to fill
1512             # corresponding data structures "correctly". Catch it later in
1513             # output_* subs.
1514             push_parameter($arg, "", $file);
1515         } elsif ($arg =~ m/\(.*\*/) {
1516             # pointer-to-function
1517             $arg =~ tr/#/,/;
1518             $arg =~ m/[^\(]+\(\*\s*([^\)]+)\)/;
1519             $param = $1;
1520             $type = $arg;
1521             $type =~ s/([^\(]+\(\*)$param/$1/;
1522             push_parameter($param, $type, $file);
1523         } elsif ($arg) {
1524             $arg =~ s/\s*:\s*/:/g;
1525             $arg =~ s/\s*\[/\[/g;
1526
1527             my @args = split('\s*,\s*', $arg);
1528             if ($args[0] =~ m/\*/) {
1529                 $args[0] =~ s/(\*+)\s*/ $1/;
1530             }
1531
1532             my @first_arg;
1533             if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1534                     shift @args;
1535                     push(@first_arg, split('\s+', $1));
1536                     push(@first_arg, $2);
1537             } else {
1538                     @first_arg = split('\s+', shift @args);
1539             }
1540
1541             unshift(@args, pop @first_arg);
1542             $type = join " ", @first_arg;
1543
1544             foreach $param (@args) {
1545                 if ($param =~ m/^(\*+)\s*(.*)/) {
1546                     push_parameter($2, "$type $1", $file);
1547                 }
1548                 elsif ($param =~ m/(.*?):(\d+)/) {
1549                     push_parameter($1, "$type:$2", $file)
1550                 }
1551                 else {
1552                     push_parameter($param, $type, $file);
1553                 }
1554             }
1555         }
1556     }
1557 }
1558
1559 sub push_parameter($$$) {
1560         my $param = shift;
1561         my $type = shift;
1562         my $file = shift;
1563
1564         if (($anon_struct_union == 1) && ($type eq "") &&
1565             ($param eq "}")) {
1566                 return;         # ignore the ending }; from anon. struct/union
1567         }
1568
1569         $anon_struct_union = 0;
1570         my $param_name = $param;
1571         $param_name =~ s/\[.*//;
1572
1573         if ($type eq "" && $param =~ /\.\.\.$/)
1574         {
1575             $type="";
1576             $parameterdescs{$param} = "variable arguments";
1577         }
1578         elsif ($type eq "" && ($param eq "" or $param eq "void"))
1579         {
1580             $type="";
1581             $param="void";
1582             $parameterdescs{void} = "no arguments";
1583         }
1584         elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1585         # handle unnamed (anonymous) union or struct:
1586         {
1587                 $type = $param;
1588                 $param = "{unnamed_" . $param . "}";
1589                 $parameterdescs{$param} = "anonymous\n";
1590                 $anon_struct_union = 1;
1591         }
1592
1593         # warn if parameter has no description
1594         # (but ignore ones starting with # as these are not parameters
1595         # but inline preprocessor statements);
1596         # also ignore unnamed structs/unions;
1597         if (!$anon_struct_union) {
1598         if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {
1599
1600             $parameterdescs{$param_name} = $undescribed;
1601
1602             if (($type eq 'function') || ($type eq 'enum')) {
1603                 print STDERR "Warning(${file}:$.): Function parameter ".
1604                     "or member '$param' not " .
1605                     "described in '$declaration_name'\n";
1606             }
1607             print STDERR "Warning(${file}:$.):".
1608                          " No description found for parameter '$param'\n";
1609             ++$warnings;
1610         }
1611         }
1612
1613         push @parameterlist, $param;
1614         $parametertypes{$param} = $type;
1615 }
1616
1617 ##
1618 # takes a function prototype and the name of the current file being
1619 # processed and spits out all the details stored in the global
1620 # arrays/hashes.
1621 sub dump_function($$) {
1622     my $prototype = shift;
1623     my $file = shift;
1624
1625     $prototype =~ s/^static +//;
1626     $prototype =~ s/^extern +//;
1627     $prototype =~ s/^fastcall +//;
1628     $prototype =~ s/^asmlinkage +//;
1629     $prototype =~ s/^inline +//;
1630     $prototype =~ s/^__inline__ +//;
1631     $prototype =~ s/^__inline +//;
1632     $prototype =~ s/^__always_inline +//;
1633     $prototype =~ s/^noinline +//;
1634     $prototype =~ s/__devinit +//;
1635     $prototype =~ s/^#define\s+//; #ak added
1636     $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//;
1637
1638     # Yes, this truly is vile.  We are looking for:
1639     # 1. Return type (may be nothing if we're looking at a macro)
1640     # 2. Function name
1641     # 3. Function parameters.
1642     #
1643     # All the while we have to watch out for function pointer parameters
1644     # (which IIRC is what the two sections are for), C types (these
1645     # regexps don't even start to express all the possibilities), and
1646     # so on.
1647     #
1648     # If you mess with these regexps, it's a good idea to check that
1649     # the following functions' documentation still comes out right:
1650     # - parport_register_device (function pointer parameters)
1651     # - atomic_set (macro)
1652     # - pci_match_device, __copy_to_user (long return type)
1653
1654     if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1655         $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1656         $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1657         $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1658         $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1659         $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1660         $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1661         $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1662         $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1663         $prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1664         $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1665         $prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1666         $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1667         $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1668         $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1669         $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1670         $prototype =~ m/^(\w+\s+\w+\s*\*\s*\w+\s*\*\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/)  {
1671         $return_type = $1;
1672         $declaration_name = $2;
1673         my $args = $3;
1674
1675         create_parameterlist($args, ',', $file);
1676     } else {
1677         print STDERR "Error(${file}:$.): cannot understand prototype: '$prototype'\n";
1678         ++$errors;
1679         return;
1680     }
1681
1682     output_declaration($declaration_name,
1683                        'function',
1684                        {'function' => $declaration_name,
1685                         'module' => $modulename,
1686                         'functiontype' => $return_type,
1687                         'parameterlist' => \@parameterlist,
1688                         'parameterdescs' => \%parameterdescs,
1689                         'parametertypes' => \%parametertypes,
1690                         'sectionlist' => \@sectionlist,
1691                         'sections' => \%sections,
1692                         'purpose' => $declaration_purpose
1693                        });
1694 }
1695
1696 sub process_file($);
1697
1698 # Read the file that maps relative names to absolute names for
1699 # separate source and object directories and for shadow trees.
1700 if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
1701         my ($relname, $absname);
1702         while(<SOURCE_MAP>) {
1703                 chop();
1704                 ($relname, $absname) = (split())[0..1];
1705                 $relname =~ s:^/+::;
1706                 $source_map{$relname} = $absname;
1707         }
1708         close(SOURCE_MAP);
1709 }
1710
1711 if ($filelist) {
1712         open(FLIST,"<$filelist") or die "Can't open file list $filelist";
1713         while(<FLIST>) {
1714                 chop;
1715                 process_file($_);
1716         }
1717 }
1718
1719 foreach (@ARGV) {
1720     chomp;
1721     process_file($_);
1722 }
1723 if ($verbose && $errors) {
1724   print STDERR "$errors errors\n";
1725 }
1726 if ($verbose && $warnings) {
1727   print STDERR "$warnings warnings\n";
1728 }
1729
1730 exit($errors);
1731
1732 sub reset_state {
1733     $function = "";
1734     %constants = ();
1735     %parameterdescs = ();
1736     %parametertypes = ();
1737     @parameterlist = ();
1738     %sections = ();
1739     @sectionlist = ();
1740     $prototype = "";
1741
1742     $state = 0;
1743 }
1744
1745 sub process_state3_function($$) {
1746     my $x = shift;
1747     my $file = shift;
1748
1749     $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1750
1751     if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#define/)) {
1752         # do nothing
1753     }
1754     elsif ($x =~ /([^\{]*)/) {
1755         $prototype .= $1;
1756     }
1757     if (($x =~ /\{/) || ($x =~ /\#define/) || ($x =~ /;/)) {
1758         $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1759         $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1760         $prototype =~ s@^\s+@@gos; # strip leading spaces
1761         dump_function($prototype,$file);
1762         reset_state();
1763     }
1764 }
1765
1766 sub process_state3_type($$) {
1767     my $x = shift;
1768     my $file = shift;
1769
1770     $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1771     $x =~ s@^\s+@@gos; # strip leading spaces
1772     $x =~ s@\s+$@@gos; # strip trailing spaces
1773     $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1774
1775     if ($x =~ /^#/) {
1776         # To distinguish preprocessor directive from regular declaration later.
1777         $x .= ";";
1778     }
1779
1780     while (1) {
1781         if ( $x =~ /([^{};]*)([{};])(.*)/ ) {
1782             $prototype .= $1 . $2;
1783             ($2 eq '{') && $brcount++;
1784             ($2 eq '}') && $brcount--;
1785             if (($2 eq ';') && ($brcount == 0)) {
1786                 dump_declaration($prototype,$file);
1787                 reset_state();
1788                 last;
1789             }
1790             $x = $3;
1791         } else {
1792             $prototype .= $x;
1793             last;
1794         }
1795     }
1796 }
1797
1798 # xml_escape: replace <, >, and & in the text stream;
1799 #
1800 # however, formatting controls that are generated internally/locally in the
1801 # kernel-doc script are not escaped here; instead, they begin life like
1802 # $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings
1803 # are converted to their mnemonic-expected output, without the 4 * '\' & ':',
1804 # just before actual output; (this is done by local_unescape())
1805 sub xml_escape($) {
1806         my $text = shift;
1807         if (($output_mode eq "text") || ($output_mode eq "man")) {
1808                 return $text;
1809         }
1810         $text =~ s/\&/\\\\\\amp;/g;
1811         $text =~ s/\</\\\\\\lt;/g;
1812         $text =~ s/\>/\\\\\\gt;/g;
1813         return $text;
1814 }
1815
1816 # convert local escape strings to html
1817 # local escape strings look like:  '\\\\menmonic:' (that's 4 backslashes)
1818 sub local_unescape($) {
1819         my $text = shift;
1820         if (($output_mode eq "text") || ($output_mode eq "man")) {
1821                 return $text;
1822         }
1823         $text =~ s/\\\\\\\\lt:/</g;
1824         $text =~ s/\\\\\\\\gt:/>/g;
1825         return $text;
1826 }
1827
1828 sub process_file($) {
1829     my $file;
1830     my $identifier;
1831     my $func;
1832     my $descr;
1833     my $initial_section_counter = $section_counter;
1834
1835     if (defined($ENV{'SRCTREE'})) {
1836         $file = "$ENV{'SRCTREE'}" . "/" . "@_";
1837     }
1838     else {
1839         $file = "@_";
1840     }
1841     if (defined($source_map{$file})) {
1842         $file = $source_map{$file};
1843     }
1844
1845     if (!open(IN,"<$file")) {
1846         print STDERR "Error: Cannot open file $file\n";
1847         ++$errors;
1848         return;
1849     }
1850
1851     $section_counter = 0;
1852     while (<IN>) {
1853         if ($state == 0) {
1854             if (/$doc_start/o) {
1855                 $state = 1;             # next line is always the function name
1856                 $in_doc_sect = 0;
1857             }
1858         } elsif ($state == 1) { # this line is the function name (always)
1859             if (/$doc_block/o) {
1860                 $state = 4;
1861                 $contents = "";
1862                 if ( $1 eq "" ) {
1863                         $section = $section_intro;
1864                 } else {
1865                         $section = $1;
1866                 }
1867             }
1868             elsif (/$doc_decl/o) {
1869                 $identifier = $1;
1870                 if (/\s*([\w\s]+?)\s*-/) {
1871                     $identifier = $1;
1872                 }
1873
1874                 $state = 2;
1875                 if (/-(.*)/) {
1876                     # strip leading/trailing/multiple spaces
1877                     $descr= $1;
1878                     $descr =~ s/^\s*//;
1879                     $descr =~ s/\s*$//;
1880                     $descr =~ s/\s+/ /;
1881                     $declaration_purpose = xml_escape($descr);
1882                 } else {
1883                     $declaration_purpose = "";
1884                 }
1885
1886                 if (($declaration_purpose eq "") && $verbose) {
1887                         print STDERR "Warning(${file}:$.): missing initial short description on line:\n";
1888                         print STDERR $_;
1889                         ++$warnings;
1890                 }
1891
1892                 if ($identifier =~ m/^struct/) {
1893                     $decl_type = 'struct';
1894                 } elsif ($identifier =~ m/^union/) {
1895                     $decl_type = 'union';
1896                 } elsif ($identifier =~ m/^enum/) {
1897                     $decl_type = 'enum';
1898                 } elsif ($identifier =~ m/^typedef/) {
1899                     $decl_type = 'typedef';
1900                 } else {
1901                     $decl_type = 'function';
1902                 }
1903
1904                 if ($verbose) {
1905                     print STDERR "Info(${file}:$.): Scanning doc for $identifier\n";
1906                 }
1907             } else {
1908                 print STDERR "Warning(${file}:$.): Cannot understand $_ on line $.",
1909                 " - I thought it was a doc line\n";
1910                 ++$warnings;
1911                 $state = 0;
1912             }
1913         } elsif ($state == 2) { # look for head: lines, and include content
1914             if (/$doc_sect/o) {
1915                 $newsection = $1;
1916                 $newcontents = $2;
1917
1918                 if (($contents ne "") && ($contents ne "\n")) {
1919                     if (!$in_doc_sect && $verbose) {
1920                         print STDERR "Warning(${file}:$.): contents before sections\n";
1921                         ++$warnings;
1922                     }
1923                     dump_section($section, xml_escape($contents));
1924                     $section = $section_default;
1925                 }
1926
1927                 $in_doc_sect = 1;
1928                 $contents = $newcontents;
1929                 if ($contents ne "") {
1930                     while ((substr($contents, 0, 1) eq " ") ||
1931                         substr($contents, 0, 1) eq "\t") {
1932                             $contents = substr($contents, 1);
1933                     }
1934                     $contents .= "\n";
1935                 }
1936                 $section = $newsection;
1937             } elsif (/$doc_end/) {
1938
1939                 if ($contents ne "") {
1940                     dump_section($section, xml_escape($contents));
1941                     $section = $section_default;
1942                     $contents = "";
1943                 }
1944
1945                 $prototype = "";
1946                 $state = 3;
1947                 $brcount = 0;
1948 #               print STDERR "end of doc comment, looking for prototype\n";
1949             } elsif (/$doc_content/) {
1950                 # miguel-style comment kludge, look for blank lines after
1951                 # @parameter line to signify start of description
1952                 if ($1 eq "" &&
1953                         ($section =~ m/^@/ || $section eq $section_context)) {
1954                     dump_section($section, xml_escape($contents));
1955                     $section = $section_default;
1956                     $contents = "";
1957                 } else {
1958                     $contents .= $1."\n";
1959                 }
1960             } else {
1961                 # i dont know - bad line?  ignore.
1962                 print STDERR "Warning(${file}:$.): bad line: $_";
1963                 ++$warnings;
1964             }
1965         } elsif ($state == 3) { # scanning for function '{' (end of prototype)
1966             if ($decl_type eq 'function') {
1967                 process_state3_function($_, $file);
1968             } else {
1969                 process_state3_type($_, $file);
1970             }
1971         } elsif ($state == 4) {
1972                 # Documentation block
1973                 if (/$doc_block/) {
1974                         dump_doc_section($section, xml_escape($contents));
1975                         $contents = "";
1976                         $function = "";
1977                         %constants = ();
1978                         %parameterdescs = ();
1979                         %parametertypes = ();
1980                         @parameterlist = ();
1981                         %sections = ();
1982                         @sectionlist = ();
1983                         $prototype = "";
1984                         if ( $1 eq "" ) {
1985                                 $section = $section_intro;
1986                         } else {
1987                                 $section = $1;
1988                         }
1989                 }
1990                 elsif (/$doc_end/)
1991                 {
1992                         dump_doc_section($section, xml_escape($contents));
1993                         $contents = "";
1994                         $function = "";
1995                         %constants = ();
1996                         %parameterdescs = ();
1997                         %parametertypes = ();
1998                         @parameterlist = ();
1999                         %sections = ();
2000                         @sectionlist = ();
2001                         $prototype = "";
2002                         $state = 0;
2003                 }
2004                 elsif (/$doc_content/)
2005                 {
2006                         if ( $1 eq "" )
2007                         {
2008                                 $contents .= $blankline;
2009                         }
2010                         else
2011                         {
2012                                 $contents .= $1 . "\n";
2013                         }
2014                 }
2015         }
2016     }
2017     if ($initial_section_counter == $section_counter) {
2018         print STDERR "Warning(${file}): no structured comments found\n";
2019         if ($output_mode eq "xml") {
2020             # The template wants at least one RefEntry here; make one.
2021             print "<refentry>\n";
2022             print " <refnamediv>\n";
2023             print "  <refname>\n";
2024             print "   ${file}\n";
2025             print "  </refname>\n";
2026             print "  <refpurpose>\n";
2027             print "   Document generation inconsistency\n";
2028             print "  </refpurpose>\n";
2029             print " </refnamediv>\n";
2030             print " <refsect1>\n";
2031             print "  <title>\n";
2032             print "   Oops\n";
2033             print "  </title>\n";
2034             print "  <warning>\n";
2035             print "   <para>\n";
2036             print "    The template for this document tried to insert\n";
2037             print "    the structured comment from the file\n";
2038             print "    <filename>${file}</filename> at this point,\n";
2039             print "    but none was found.\n";
2040             print "    This dummy section is inserted to allow\n";
2041             print "    generation to continue.\n";
2042             print "   </para>\n";
2043             print "  </warning>\n";
2044             print " </refsect1>\n";
2045             print "</refentry>\n";
2046         }
2047     }
2048 }