#!/usr/bin/env perl

  use warnings;

  use strict;
  
  ## Copyright (c) 1998 Michael Zucchi, All Rights Reserved        ##
  ## Copyright (C) 2000, 1  Tim Waugh <twaugh@redhat.com>          ##
  ## Copyright (C) 2001  Simon Huggins                             ##

  ## Copyright (C) 2005-2012  Randy Dunlap                         ##

  ## Copyright (C) 2012  Dan Luedtke                               ##

  ## 								 ##
  ## #define enhancements by Armin Kuster <akuster@mvista.com>	 ##
  ## Copyright (c) 2000 MontaVista Software, Inc.			 ##
  ## 								 ##
  ## This software falls under the GNU General Public License.     ##
  ## Please read the COPYING file for more information             ##

  # 18/01/2001 - 	Cleanups
  # 		Functions prototyped as foo(void) same as foo()
  # 		Stop eval'ing where we don't need to.
  # -- huggie@earth.li
  
  # 27/06/2001 -  Allowed whitespace after initial "/**" and
  #               allowed comments before function declarations.
  # -- Christian Kreibich <ck@whoop.org>
  
  # Still to do:
  # 	- add perldoc documentation
  # 	- Look more closely at some of the scarier bits :)
  
  # 26/05/2001 - 	Support for separate source and object trees.
  #		Return error code.
  # 		Keith Owens <kaos@ocs.com.au>
  
  # 23/09/2001 - Added support for typedefs, structs, enums and unions
  #              Support for Context section; can be terminated using empty line
  #              Small fixes (like spaces vs. \s in regex)
  # -- Tim Jansen <tim@tjansen.de>

  # 25/07/2012 - Added support for HTML5
  # -- Dan Luedtke <mail@danrl.de>

  sub usage {
      my $message = <<"EOF";
  Usage: $0 [OPTION ...] FILE ...
  
  Read C language source or header FILEs, extract embedded documentation comments,
  and print formatted documentation to standard output.
  
  The documentation comments are identified by "/**" opening comment mark. See
  Documentation/kernel-doc-nano-HOWTO.txt for the documentation comment syntax.
  
  Output format selection (mutually exclusive):
    -docbook		Output DocBook format.
    -html			Output HTML format.
    -html5		Output HTML5 format.
    -list			Output symbol list format. This is for use by docproc.
    -man			Output troff manual page format. This is the default.

    -rst			Output reStructuredText format.

    -text			Output plain text format.
  
  Output selection (mutually exclusive):

    -export		Only output documentation for symbols that have been
  			exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()

                          in any input FILE or -export-file FILE.

    -internal		Only output documentation for symbols that have NOT been
  			exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()

                          in any input FILE or -export-file FILE.

    -function NAME	Only output documentation for the given function(s)
  			or DOC: section title(s). All other functions and DOC:
  			sections are ignored. May be specified multiple times.
    -nofunction NAME	Do NOT output documentation for the given function(s);
  			only output documentation for the other functions and
  			DOC: sections. May be specified multiple times.
  
  Output selection modifiers:
    -no-doc-sections	Do not output DOC: sections.

    -enable-lineno        Enable output of #define LINENO lines. Only works with
                          reStructuredText format.

    -export-file FILE     Specify an additional FILE in which to look for
                          EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with
                          -export or -internal. May be specified multiple times.

  
  Other parameters:
    -v			Verbose output, more warnings and other information.
    -h			Print this help.
  
  EOF
      print $message;
      exit 1;
  }

  
  #
  # format of comments.
  # In the following table, (...)? signifies optional structure.
  #                         (...)* signifies 0 or more structure elements
  # /**
  #  * function_name(:)? (- short description)?
  # (* @parameterx: (description of parameter x)?)*
  # (* a blank line)?
  #  * (Description:)? (Description of function)?
  #  * (section header: (section description)? )*
  #  (*)?*/
  #
  # So .. the trivial example would be:
  #
  # /**
  #  * my_function

  #  */

  #

  # If the Description: header tag is omitted, then there must be a blank line

  # after the last parameter specification.
  # e.g.
  # /**
  #  * my_function - does my stuff
  #  * @my_arg: its mine damnit
  #  *

  #  * Does my stuff explained.

  #  */
  #
  #  or, could also use:
  # /**
  #  * my_function - does my stuff
  #  * @my_arg: its mine damnit

  #  * Description: Does my stuff explained.

  #  */
  # etc.
  #

  # Besides functions you can also write documentation for structs, unions,

  # enums and typedefs. Instead of the function name you must write the name
  # of the declaration;  the struct/union/enum/typedef must always precede
  # the name. Nesting of declarations is not supported.

  # Use the argument mechanism to document members or constants.
  # e.g.
  # /**
  #  * struct my_struct - short description
  #  * @a: first member
  #  * @b: second member

  #  *

  #  * Longer description
  #  */
  # struct my_struct {
  #     int a;
  #     int b;

  # /* private: */
  #     int c;

  # };
  #
  # All descriptions can be multiline, except the short function description.

  #

  # For really longs structs, you can also describe arguments inside the
  # body of the struct.
  # eg.
  # /**
  #  * struct my_struct - short description
  #  * @a: first member
  #  * @b: second member
  #  *
  #  * Longer description
  #  */
  # struct my_struct {
  #     int a;
  #     int b;
  #     /**
  #      * @c: This is longer description of C
  #      *
  #      * You can use paragraphs to describe arguments
  #      * using this method.
  #      */
  #     int c;
  # };
  #
  # This should be use only for struct/enum members.
  #

  # You can also add additional sections. When documenting kernel functions you
  # should document the "Context:" of the function, e.g. whether the functions

  # can be called form interrupts. Unlike other sections you can end it with an

  # empty line.

  # A non-void function should have a "Return:" section describing the return
  # value(s).

  # Example-sections should contain the string EXAMPLE so that they are marked

  # appropriately in DocBook.
  #
  # Example:
  # /**
  #  * user_function - function that can only be called in user context
  #  * @a: some argument
  #  * Context: !in_interrupt()

  #  *

  #  * Some description
  #  * Example:
  #  *    user_function(22);
  #  */
  # ...
  #
  #
  # All descriptive text is further processed, scanning for the following special
  # patterns, which are highlighted appropriately.
  #
  # 'funcname()' - function
  # '$ENVVAR' - environmental variable
  # '&struct_name' - name of a structure (up to two words including 'struct')

  # '&struct_name.member' - name of a structure member

  # '@parameter' - name of a parameter
  # '%CONST' - name of a constant.

  # '``LITERAL``' - literal string without any spaces on it.

  ## init lots of data

  my $errors = 0;
  my $warnings = 0;

  my $anon_struct_union = 0;

  
  # match expressions used to find embedded type information

  my $type_constant = '\b``([^\`]+)``\b';
  my $type_constant2 = '\%([-_\w]+)';

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

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

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

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

  my $type_enum = '\&(enum\s*([_\w]+))';
  my $type_struct = '\&(struct\s*([_\w]+))';
  my $type_typedef = '\&(typedef\s*([_\w]+))';
  my $type_union = '\&(union\s*([_\w]+))';

  my $type_member = '\&([_\w]+)(\.|->)([_\w]+)';

  my $type_fallback = '\&([_\w]+)';
  my $type_enum_xml = '\&(enum\s*([_\w]+))';
  my $type_struct_xml = '\&(struct\s*([_\w]+))';
  my $type_typedef_xml = '\&(typedef\s*([_\w]+))';
  my $type_union_xml = '\&(union\s*([_\w]+))';

  my $type_member_xml = '\&([_\w]+)(\.|-\>)([_\w]+)';

  my $type_fallback_xml = '\&amp([_\w]+)';

  my $type_member_func = $type_member . '\(\)';

  
  # Output conversion substitutions.
  #  One for each output format
  
  # these work fairly well

  my @highlights_html = (
                         [$type_constant, "<i>\$1</i>"],

                         [$type_constant2, "<i>\$1</i>"],

                         [$type_func, "<b>\$1</b>"],

                         [$type_enum_xml, "<i>\$1</i>"],

                         [$type_struct_xml, "<i>\$1</i>"],

                         [$type_typedef_xml, "<i>\$1</i>"],
                         [$type_union_xml, "<i>\$1</i>"],

                         [$type_env, "<b><i>\$1</i></b>"],

                         [$type_param, "<tt><b>\$1</b></tt>"],

                         [$type_member_xml, "<tt><i>\$1</i>\$2\$3</tt>"],
                         [$type_fallback_xml, "<i>\$1</i>"]

                        );

  my $local_lt = "\\\\\\\\lt:";
  my $local_gt = "\\\\\\\\gt:";
  my $blankline_html = $local_lt . "p" . $local_gt;	# was "<p>"

  # html version 5

  my @highlights_html5 = (
                          [$type_constant, "<span class=\"const\">\$1</span>"],

                          [$type_constant2, "<span class=\"const\">\$1</span>"],

                          [$type_func, "<span class=\"func\">\$1</span>"],

                          [$type_enum_xml, "<span class=\"enum\">\$1</span>"],

                          [$type_struct_xml, "<span class=\"struct\">\$1</span>"],

                          [$type_typedef_xml, "<span class=\"typedef\">\$1</span>"],
                          [$type_union_xml, "<span class=\"union\">\$1</span>"],

                          [$type_env, "<span class=\"env\">\$1</span>"],

                          [$type_param, "<span class=\"param\">\$1</span>]"],

                          [$type_member_xml, "<span class=\"literal\"><span class=\"struct\">\$1</span>\$2<span class=\"member\">\$3</span></span>"],
                          [$type_fallback_xml, "<span class=\"struct\">\$1</span>"]

  		       );

  my $blankline_html5 = $local_lt . "br /" . $local_gt;

  # XML, docbook format

  my @highlights_xml = (
                        ["([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>"],
                        [$type_constant, "<constant>\$1</constant>"],

                        [$type_constant2, "<constant>\$1</constant>"],

                        [$type_enum_xml, "<type>\$1</type>"],

                        [$type_struct_xml, "<structname>\$1</structname>"],

                        [$type_typedef_xml, "<type>\$1</type>"],
                        [$type_union_xml, "<structname>\$1</structname>"],

                        [$type_param, "<parameter>\$1</parameter>"],
                        [$type_func, "<function>\$1</function>"],

                        [$type_env, "<envar>\$1</envar>"],

                        [$type_member_xml, "<literal><structname>\$1</structname>\$2<structfield>\$3</structfield></literal>"],
                        [$type_fallback_xml, "<structname>\$1</structname>"]

  		     );

  my $blankline_xml = $local_lt . "/para" . $local_gt . $local_lt . "para" . $local_gt . "
  ";

  
  # gnome, docbook format

  my @highlights_gnome = (
                          [$type_constant, "<replaceable class=\"option\">\$1</replaceable>"],

                          [$type_constant2, "<replaceable class=\"option\">\$1</replaceable>"],

                          [$type_func, "<function>\$1</function>"],

                          [$type_enum, "<type>\$1</type>"],

                          [$type_struct, "<structname>\$1</structname>"],

                          [$type_typedef, "<type>\$1</type>"],
                          [$type_union, "<structname>\$1</structname>"],

                          [$type_env, "<envar>\$1</envar>"],

                          [$type_param, "<parameter>\$1</parameter>" ],

                          [$type_member, "<literal><structname>\$1</structname>\$2<structfield>\$3</structfield></literal>"],
                          [$type_fallback, "<structname>\$1</structname>"]

  		       );

  my $blankline_gnome = "</para><para>
  ";
  
  # these are pretty rough

  my @highlights_man = (
                        [$type_constant, "\$1"],

                        [$type_constant2, "\$1"],

                        [$type_func, "\\\\fB\$1\\\\fP"],

                        [$type_enum, "\\\\fI\$1\\\\fP"],

                        [$type_struct, "\\\\fI\$1\\\\fP"],

                        [$type_typedef, "\\\\fI\$1\\\\fP"],
                        [$type_union, "\\\\fI\$1\\\\fP"],

                        [$type_param, "\\\\fI\$1\\\\fP"],

                        [$type_member, "\\\\fI\$1\$2\$3\\\\fP"],
                        [$type_fallback, "\\\\fI\$1\\\\fP"]

  		     );

  my $blankline_man = "";
  
  # text-mode

  my @highlights_text = (
                         [$type_constant, "\$1"],

                         [$type_constant2, "\$1"],

                         [$type_func, "\$1"],

                         [$type_enum, "\$1"],

                         [$type_struct, "\$1"],

                         [$type_typedef, "\$1"],
                         [$type_union, "\$1"],

                         [$type_param, "\$1"],

                         [$type_member, "\$1\$2\$3"],
                         [$type_fallback, "\$1"]

  		      );

  my $blankline_text = "";

  # rst-mode
  my @highlights_rst = (
                         [$type_constant, "``\$1``"],

                         [$type_constant2, "``\$1``"],

                         # Note: need to escape () to avoid func matching later

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

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

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

                         [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"],
                         [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"],
                         [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"],
                         [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"],

                         # in rst this can refer to any type

                         [$type_fallback, "\\:c\\:type\\:`\$1`"],

                         [$type_param, "**\$1**"]
  		      );
  my $blankline_rst = "
  ";

  # list mode

  my @highlights_list = (
                         [$type_constant, "\$1"],

                         [$type_constant2, "\$1"],

                         [$type_func, "\$1"],

                         [$type_enum, "\$1"],

                         [$type_struct, "\$1"],

                         [$type_typedef, "\$1"],
                         [$type_union, "\$1"],

                         [$type_param, "\$1"],

                         [$type_member, "\$1"],
                         [$type_fallback, "\$1"]

  		      );

  my $blankline_list = "";

  # read arguments

  if ($#ARGV == -1) {

      usage();
  }

  my $kernelversion;
  my $dohighlight = "";

  my $verbose = 0;
  my $output_mode = "man";

  my $output_preformatted = 0;

  my $no_doc_sections = 0;

  my $enable_lineno = 0;

  my @highlights = @highlights_man;

  my $blankline = $blankline_man;
  my $modulename = "Kernel API";

  
  use constant {
      OUTPUT_ALL          => 0, # output all symbols and doc sections
      OUTPUT_INCLUDE      => 1, # output only specified symbols
      OUTPUT_EXCLUDE      => 2, # output everything except specified symbols
      OUTPUT_EXPORTED     => 3, # output exported symbols
      OUTPUT_INTERNAL     => 4, # output non-exported symbols
  };
  my $output_selection = OUTPUT_ALL;

  my $show_not_found = 0;

  my @export_file_list;

  my @build_time;
  if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
      (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
      @build_time = gmtime($seconds);
  } else {
      @build_time = localtime;
  }

  my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
  		'July', 'August', 'September', 'October',

  		'November', 'December')[$build_time[4]] .
    " " . ($build_time[5]+1900);

  # Essentially these are globals.

  # They probably want to be tidied up, made more localised or something.
  # CAVEAT EMPTOR!  Some of the others I localised may not want to be, which

  # could cause "use of undefined value" or other bugs.

  my ($function, %function_table, %parametertypes, $declaration_purpose);

  my $declaration_start_line;

  my ($type, $declaration_name, $return_type);

  my ($newsection, $newcontents, $prototype, $brcount, %source_map);

  if (defined($ENV{'KBUILD_VERBOSE'})) {
  	$verbose = "$ENV{'KBUILD_VERBOSE'}";
  }

  # Generated docbook code is inserted in a template at a point where

  # docbook v3.1 requires a non-zero sequence of RefEntry's; see:
  # http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
  # We keep track of number of generated entries and generate a dummy
  # if needs be to ensure the expanded template can be postprocessed
  # into html.
  my $section_counter = 0;
  
  my $lineprefix="";

  # Parser states
  use constant {
      STATE_NORMAL        => 0, # normal code
      STATE_NAME          => 1, # looking for function name
      STATE_FIELD         => 2, # scanning field start
      STATE_PROTO         => 3, # scanning prototype
      STATE_DOCBLOCK      => 4, # documentation block
      STATE_INLINE        => 5, # gathering documentation outside main block
  };

  my $state;

  my $in_doc_sect;

  # Inline documentation state
  use constant {
      STATE_INLINE_NA     => 0, # not applicable ($state != STATE_INLINE)
      STATE_INLINE_NAME   => 1, # looking for member name (@foo:)
      STATE_INLINE_TEXT   => 2, # looking for member documentation
      STATE_INLINE_END    => 3, # done
      STATE_INLINE_ERROR  => 4, # error - Comment without header was found.
                                # Spit a warning as it's not
                                # proper kernel-doc and ignore the rest.
  };
  my $inline_doc_state;

  #declaration types: can be
  # 'function', 'struct', 'union', 'enum', 'typedef'
  my $decl_type;

  my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
  my $doc_end = '\*/';
  my $doc_com = '\s*\*\s*';

  my $doc_com_body = '\s*\* ?';

  my $doc_decl = $doc_com . '(\w+)';

  # @params and a strictly limited set of supported section names

  my $doc_sect = $doc_com . 

      '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)';

  my $doc_content = $doc_com_body . '(.*)';

  my $doc_block = $doc_com . 'DOC:\s*(.*)?';

  my $doc_inline_start = '^\s*/\*\*\s*$';
  my $doc_inline_sect = '\s*\*\s*(@[\w\s]+):(.*)';
  my $doc_inline_end = '^\s*\*/\s*$';

  my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';

  my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';

  my %parameterdescs;

  my %parameterdesc_start_lines;

  my @parameterlist;
  my %sections;
  my @sectionlist;

  my %section_start_lines;

  my $sectcheck;
  my $struct_actual;

  
  my $contents = "";

  my $new_start_line = 0;

  
  # the canonical section names. see also $doc_sect above.

  my $section_default = "Description";	# default section
  my $section_intro = "Introduction";
  my $section = $section_default;
  my $section_context = "Context";

  my $section_return = "Return";

  
  my $undescribed = "-- undescribed --";
  
  reset_state();
  
  while ($ARGV[0] =~ m/^-(.*)/) {
      my $cmd = shift @ARGV;
      if ($cmd eq "-html") {
  	$output_mode = "html";

  	@highlights = @highlights_html;

  	$blankline = $blankline_html;

      } elsif ($cmd eq "-html5") {
  	$output_mode = "html5";

  	@highlights = @highlights_html5;

  	$blankline = $blankline_html5;

      } elsif ($cmd eq "-man") {
  	$output_mode = "man";

  	@highlights = @highlights_man;

  	$blankline = $blankline_man;
      } elsif ($cmd eq "-text") {
  	$output_mode = "text";

  	@highlights = @highlights_text;

  	$blankline = $blankline_text;

      } elsif ($cmd eq "-rst") {
  	$output_mode = "rst";
  	@highlights = @highlights_rst;
  	$blankline = $blankline_rst;

      } elsif ($cmd eq "-docbook") {
  	$output_mode = "xml";

  	@highlights = @highlights_xml;

  	$blankline = $blankline_xml;

      } elsif ($cmd eq "-list") {
  	$output_mode = "list";

  	@highlights = @highlights_list;

  	$blankline = $blankline_list;

      } elsif ($cmd eq "-gnome") {
  	$output_mode = "gnome";

  	@highlights = @highlights_gnome;

  	$blankline = $blankline_gnome;
      } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document
  	$modulename = shift @ARGV;
      } elsif ($cmd eq "-function") { # to only output specific functions

  	$output_selection = OUTPUT_INCLUDE;

  	$function = shift @ARGV;
  	$function_table{$function} = 1;

      } elsif ($cmd eq "-nofunction") { # output all except specific functions
  	$output_selection = OUTPUT_EXCLUDE;

  	$function = shift @ARGV;
  	$function_table{$function} = 1;

      } elsif ($cmd eq "-export") { # only exported symbols

  	$output_selection = OUTPUT_EXPORTED;

  	%function_table = ();

      } elsif ($cmd eq "-internal") { # only non-exported symbols

  	$output_selection = OUTPUT_INTERNAL;

  	%function_table = ();

      } elsif ($cmd eq "-export-file") {
  	my $file = shift @ARGV;
  	push(@export_file_list, $file);

      } elsif ($cmd eq "-v") {
  	$verbose = 1;
      } elsif (($cmd eq "-h") || ($cmd eq "--help")) {
  	usage();

      } elsif ($cmd eq '-no-doc-sections') {
  	    $no_doc_sections = 1;

      } elsif ($cmd eq '-enable-lineno') {
  	    $enable_lineno = 1;

      } elsif ($cmd eq '-show-not-found') {
  	$show_not_found = 1;

      }
  }

  # continue execution near EOF;

  # get kernel version from env
  sub get_kernel_version() {

      my $version = 'unknown kernel version';

  
      if (defined($ENV{'KERNELVERSION'})) {
  	$version = $ENV{'KERNELVERSION'};
      }
      return $version;
  }

  #
  sub print_lineno {
      my $lineno = shift;
      if ($enable_lineno && defined($lineno)) {
          print "#define LINENO " . $lineno . "
  ";
      }
  }

  ##
  # dumps section contents to arrays/hashes intended for that purpose.
  #
  sub dump_section {

      my $file = shift;

      my $name = shift;
      my $contents = join "
  ", @_;

      if ($name =~ m/$type_param/) {

  	$name = $1;
  	$parameterdescs{$name} = $contents;

  	$sectcheck = $sectcheck . $name . " ";

          $parameterdesc_start_lines{$name} = $new_start_line;
          $new_start_line = 0;

      } elsif ($name eq "@\.\.\.") {

  	$name = "...";
  	$parameterdescs{$name} = $contents;

  	$sectcheck = $sectcheck . $name . " ";

          $parameterdesc_start_lines{$name} = $new_start_line;
          $new_start_line = 0;

      } else {

  	if (defined($sections{$name}) && ($sections{$name} ne "")) {

  	    # Only warn on user specified duplicate section names.
  	    if ($name ne $section_default) {
  		print STDERR "${file}:$.: warning: duplicate section name '$name'
  ";
  		++$warnings;
  	    }

  	    $sections{$name} .= $contents;
  	} else {
  	    $sections{$name} = $contents;
  	    push @sectionlist, $name;

              $section_start_lines{$name} = $new_start_line;
              $new_start_line = 0;

  	}

      }
  }
  
  ##

  # dump DOC: section after checking that it should go out
  #
  sub dump_doc_section {

      my $file = shift;

      my $name = shift;
      my $contents = join "
  ", @_;

      if ($no_doc_sections) {
          return;
      }

      if (($output_selection == OUTPUT_ALL) ||
  	($output_selection == OUTPUT_INCLUDE &&
  	 defined($function_table{$name})) ||
  	($output_selection == OUTPUT_EXCLUDE &&
  	 !defined($function_table{$name})))

      {

  	dump_section($file, $name, $contents);

  	output_blockhead({'sectionlist' => \@sectionlist,
  			  'sections' => \%sections,
  			  'module' => $modulename,

  			  'content-only' => ($output_selection != OUTPUT_ALL), });

      }
  }
  
  ##

  # output function
  #
  # parameterdescs, a hash.
  #  function => "function name"
  #  parameterlist => @list of parameters
  #  parameterdescs => %parameter descriptions
  #  sectionlist => @list of sections

  #  sections => %section descriptions

  #

  
  sub output_highlight {
      my $contents = join "
  ",@_;
      my $line;
  
  #   DEBUG
  #   if (!defined $contents) {
  #	use Carp;
  #	confess "output_highlight got called with no args?
  ";
  #   }

      if ($output_mode eq "html" || $output_mode eq "html5" ||
  	$output_mode eq "xml") {

  	$contents = local_unescape($contents);
  	# convert data read & converted thru xml_escape() into &xyz; format:

  	$contents =~ s/\\\\\\/\&/g;

      }

  #   print STDERR "contents b4:$contents
  ";

      eval $dohighlight;
      die $@ if $@;

  #   print STDERR "contents af:$contents
  ";

  #   strip whitespaces when generating html5
      if ($output_mode eq "html5") {
  	$contents =~ s/^\s+//;
  	$contents =~ s/\s+$//;
      }

      foreach $line (split "
  ", $contents) {

  	if (! $output_preformatted) {
  	    $line =~ s/^\s*//;
  	}

  	if ($line eq ""){

  	    if (! $output_preformatted) {
  		print $lineprefix, local_unescape($blankline);
  	    }

  	} else {

  	    $line =~ s/\\\\\\/\&/g;

  	    if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
  		print "\\&$line";
  	    } else {
  		print $lineprefix, $line;
  	    }

  	}
  	print "
  ";
      }
  }

  # output sections in html

  sub output_section_html(%) {
      my %args = %{$_[0]};
      my $section;
  
      foreach $section (@{$args{'sectionlist'}}) {
  	print "<h3>$section</h3>
  ";
  	print "<blockquote>
  ";
  	output_highlight($args{'sections'}{$section});
  	print "</blockquote>
  ";

      }

  }
  
  # output enum in html
  sub output_enum_html(%) {
      my %args = %{$_[0]};
      my ($parameter);
      my $count;

      print "<h2>enum " . $args{'enum'} . "</h2>
  ";

      print "<b>enum " . $args{'enum'} . "</b> {<br>
  ";

      $count = 0;
      foreach $parameter (@{$args{'parameterlist'}}) {

  	print " <b>" . $parameter . "</b>";

  	if ($count != $#{$args{'parameterlist'}}) {
  	    $count++;
  	    print ",
  ";
  	}
  	print "<br>";
      }
      print "};<br>
  ";
  
      print "<h3>Constants</h3>
  ";
      print "<dl>
  ";
      foreach $parameter (@{$args{'parameterlist'}}) {

  	print "<dt><b>" . $parameter . "</b>
  ";

  	print "<dd>";
  	output_highlight($args{'parameterdescs'}{$parameter});
      }
      print "</dl>
  ";
      output_section_html(@_);
      print "<hr>
  ";
  }

  # output typedef in html

  sub output_typedef_html(%) {
      my %args = %{$_[0]};
      my ($parameter);
      my $count;

      print "<h2>typedef " . $args{'typedef'} . "</h2>
  ";

      print "<b>typedef " . $args{'typedef'} . "</b>
  ";

      output_section_html(@_);
      print "<hr>
  ";
  }
  
  # output struct in html
  sub output_struct_html(%) {
      my %args = %{$_[0]};
      my ($parameter);

      print "<h2>" . $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "</h2>
  ";
      print "<b>" . $args{'type'} . " " . $args{'struct'} . "</b> {<br>
  ";

      foreach $parameter (@{$args{'parameterlist'}}) {
  	if ($parameter =~ /^#/) {
  		print "$parameter<br>
  ";
  		next;
  	}
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;

  	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;

  	$type = $args{'parametertypes'}{$parameter};
  	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
  	    # pointer-to-function

  	    print "&nbsp; &nbsp; <i>$1</i><b>$parameter</b>) <i>($2)</i>;<br>
  ";

  	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {

  	    # bitfield
  	    print "&nbsp; &nbsp; <i>$1</i> <b>$parameter</b>$2;<br>
  ";

  	} else {

  	    print "&nbsp; &nbsp; <i>$type</i> <b>$parameter</b>;<br>
  ";

  	}
      }
      print "};<br>
  ";
  
      print "<h3>Members</h3>
  ";
      print "<dl>
  ";
      foreach $parameter (@{$args{'parameterlist'}}) {
  	($parameter =~ /^#/) && next;
  
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;

  	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;

  	print "<dt><b>" . $parameter . "</b>
  ";

  	print "<dd>";
  	output_highlight($args{'parameterdescs'}{$parameter_name});
      }
      print "</dl>
  ";
      output_section_html(@_);
      print "<hr>
  ";
  }
  
  # output function in html
  sub output_function_html(%) {
      my %args = %{$_[0]};
      my ($parameter, $section);
      my $count;

      print "<h2>" . $args{'function'} . " - " . $args{'purpose'} . "</h2>
  ";
      print "<i>" . $args{'functiontype'} . "</i>
  ";
      print "<b>" . $args{'function'} . "</b>
  ";

      print "(";
      $count = 0;
      foreach $parameter (@{$args{'parameterlist'}}) {
  	$type = $args{'parametertypes'}{$parameter};
  	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
  	    # pointer-to-function
  	    print "<i>$1</i><b>$parameter</b>) <i>($2)</i>";
  	} else {

  	    print "<i>" . $type . "</i> <b>" . $parameter . "</b>";

  	}
  	if ($count != $#{$args{'parameterlist'}}) {
  	    $count++;
  	    print ",
  ";
  	}
      }
      print ")
  ";
  
      print "<h3>Arguments</h3>
  ";
      print "<dl>
  ";
      foreach $parameter (@{$args{'parameterlist'}}) {
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;

  	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;

  	print "<dt><b>" . $parameter . "</b>
  ";

  	print "<dd>";
  	output_highlight($args{'parameterdescs'}{$parameter_name});
      }
      print "</dl>
  ";
      output_section_html(@_);
      print "<hr>
  ";
  }

  # output DOC: block header in html
  sub output_blockhead_html(%) {

      my %args = %{$_[0]};
      my ($parameter, $section);
      my $count;
  
      foreach $section (@{$args{'sectionlist'}}) {
  	print "<h3>$section</h3>
  ";
  	print "<ul>
  ";
  	output_highlight($args{'sections'}{$section});
  	print "</ul>
  ";
      }
      print "<hr>
  ";
  }

  # output sections in html5
  sub output_section_html5(%) {
      my %args = %{$_[0]};
      my $section;
  
      foreach $section (@{$args{'sectionlist'}}) {
  	print "<section>
  ";
  	print "<h1>$section</h1>
  ";
  	print "<p>
  ";
  	output_highlight($args{'sections'}{$section});
  	print "</p>
  ";
  	print "</section>
  ";
      }
  }
  
  # output enum in html5
  sub output_enum_html5(%) {
      my %args = %{$_[0]};
      my ($parameter);
      my $count;
      my $html5id;
  
      $html5id = $args{'enum'};
      $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
      print "<article class=\"enum\" id=\"enum:". $html5id . "\">";
      print "<h1>enum " . $args{'enum'} . "</h1>
  ";
      print "<ol class=\"code\">
  ";
      print "<li>";
      print "<span class=\"keyword\">enum</span> ";
      print "<span class=\"identifier\">" . $args{'enum'} . "</span> {";
      print "</li>
  ";
      $count = 0;
      foreach $parameter (@{$args{'parameterlist'}}) {
  	print "<li class=\"indent\">";
  	print "<span class=\"param\">" . $parameter . "</span>";
  	if ($count != $#{$args{'parameterlist'}}) {
  	    $count++;
  	    print ",";
  	}
  	print "</li>
  ";
      }
      print "<li>};</li>
  ";
      print "</ol>
  ";
  
      print "<section>
  ";
      print "<h1>Constants</h1>
  ";
      print "<dl>
  ";
      foreach $parameter (@{$args{'parameterlist'}}) {
  	print "<dt>" . $parameter . "</dt>
  ";
  	print "<dd>";
  	output_highlight($args{'parameterdescs'}{$parameter});
  	print "</dd>
  ";
      }
      print "</dl>
  ";
      print "</section>
  ";
      output_section_html5(@_);
      print "</article>
  ";
  }
  
  # output typedef in html5
  sub output_typedef_html5(%) {
      my %args = %{$_[0]};
      my ($parameter);
      my $count;
      my $html5id;
  
      $html5id = $args{'typedef'};
      $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
      print "<article class=\"typedef\" id=\"typedef:" . $html5id . "\">
  ";
      print "<h1>typedef " . $args{'typedef'} . "</h1>
  ";
  
      print "<ol class=\"code\">
  ";
      print "<li>";
      print "<span class=\"keyword\">typedef</span> ";
      print "<span class=\"identifier\">" . $args{'typedef'} . "</span>";
      print "</li>
  ";
      print "</ol>
  ";
      output_section_html5(@_);
      print "</article>
  ";
  }
  
  # output struct in html5
  sub output_struct_html5(%) {
      my %args = %{$_[0]};
      my ($parameter);
      my $html5id;
  
      $html5id = $args{'struct'};
      $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
      print "<article class=\"struct\" id=\"struct:" . $html5id . "\">
  ";
      print "<hgroup>
  ";
      print "<h1>" . $args{'type'} . " " . $args{'struct'} . "</h1>";
      print "<h2>". $args{'purpose'} . "</h2>
  ";
      print "</hgroup>
  ";
      print "<ol class=\"code\">
  ";
      print "<li>";
      print "<span class=\"type\">" . $args{'type'} . "</span> ";
      print "<span class=\"identifier\">" . $args{'struct'} . "</span> {";
      print "</li>
  ";
      foreach $parameter (@{$args{'parameterlist'}}) {
  	print "<li class=\"indent\">";
  	if ($parameter =~ /^#/) {
  		print "<span class=\"param\">" . $parameter ."</span>
  ";
  		print "</li>
  ";
  		next;
  	}
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;
  
  	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
  	$type = $args{'parametertypes'}{$parameter};
  	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
  	    # pointer-to-function
  	    print "<span class=\"type\">$1</span> ";
  	    print "<span class=\"param\">$parameter</span>";
  	    print "<span class=\"type\">)</span> ";
  	    print "(<span class=\"args\">$2</span>);";
  	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {
  	    # bitfield
  	    print "<span class=\"type\">$1</span> ";
  	    print "<span class=\"param\">$parameter</span>";
  	    print "<span class=\"bits\">$2</span>;";
  	} else {
  	    print "<span class=\"type\">$type</span> ";
  	    print "<span class=\"param\">$parameter</span>;";
  	}
  	print "</li>
  ";
      }
      print "<li>};</li>
  ";
      print "</ol>
  ";
  
      print "<section>
  ";
      print "<h1>Members</h1>
  ";
      print "<dl>
  ";
      foreach $parameter (@{$args{'parameterlist'}}) {
  	($parameter =~ /^#/) && next;
  
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;
  
  	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
  	print "<dt>" . $parameter . "</dt>
  ";
  	print "<dd>";
  	output_highlight($args{'parameterdescs'}{$parameter_name});
  	print "</dd>
  ";
      }
      print "</dl>
  ";
      print "</section>
  ";
      output_section_html5(@_);
      print "</article>
  ";
  }
  
  # output function in html5
  sub output_function_html5(%) {
      my %args = %{$_[0]};
      my ($parameter, $section);
      my $count;
      my $html5id;
  
      $html5id = $args{'function'};
      $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
      print "<article class=\"function\" id=\"func:". $html5id . "\">
  ";
      print "<hgroup>
  ";
      print "<h1>" . $args{'function'} . "</h1>";
      print "<h2>" . $args{'purpose'} . "</h2>
  ";
      print "</hgroup>
  ";
      print "<ol class=\"code\">
  ";
      print "<li>";
      print "<span class=\"type\">" . $args{'functiontype'} . "</span> ";
      print "<span class=\"identifier\">" . $args{'function'} . "</span> (";
      print "</li>";
      $count = 0;
      foreach $parameter (@{$args{'parameterlist'}}) {
  	print "<li class=\"indent\">";
  	$type = $args{'parametertypes'}{$parameter};
  	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
  	    # pointer-to-function
  	    print "<span class=\"type\">$1</span> ";
  	    print "<span class=\"param\">$parameter</span>";
  	    print "<span class=\"type\">)</span> ";
  	    print "(<span class=\"args\">$2</span>)";
  	} else {
  	    print "<span class=\"type\">$type</span> ";
  	    print "<span class=\"param\">$parameter</span>";
  	}
  	if ($count != $#{$args{'parameterlist'}}) {
  	    $count++;
  	    print ",";
  	}
  	print "</li>
  ";
      }
      print "<li>)</li>
  ";
      print "</ol>
  ";
  
      print "<section>
  ";
      print "<h1>Arguments</h1>
  ";
      print "<p>
  ";
      print "<dl>
  ";
      foreach $parameter (@{$args{'parameterlist'}}) {
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;
  
  	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
  	print "<dt>" . $parameter . "</dt>
  ";
  	print "<dd>";
  	output_highlight($args{'parameterdescs'}{$parameter_name});
  	print "</dd>
  ";
      }
      print "</dl>
  ";
      print "</section>
  ";
      output_section_html5(@_);
      print "</article>
  ";
  }
  
  # output DOC: block header in html5
  sub output_blockhead_html5(%) {
      my %args = %{$_[0]};
      my ($parameter, $section);
      my $count;
      my $html5id;
  
      foreach $section (@{$args{'sectionlist'}}) {
  	$html5id = $section;
  	$html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
  	print "<article class=\"doc\" id=\"doc:". $html5id . "\">
  ";
  	print "<h1>$section</h1>
  ";
  	print "<p>
  ";
  	output_highlight($args{'sections'}{$section});
  	print "</p>
  ";
      }
      print "</article>
  ";
  }

  sub output_section_xml(%) {
      my %args = %{$_[0]};

      my $section;

      # print out each section
      $lineprefix="   ";
      foreach $section (@{$args{'sectionlist'}}) {

  	print "<refsect1>
  ";
  	print "<title>$section</title>
  ";

  	if ($section =~ m/EXAMPLE/i) {

  	    print "<informalexample><programlisting>
  ";

  	    $output_preformatted = 1;

  	} else {
  	    print "<para>
  ";

  	}
  	output_highlight($args{'sections'}{$section});

  	$output_preformatted = 0;

  	if ($section =~ m/EXAMPLE/i) {

  	    print "</programlisting></informalexample>
  ";
  	} else {
  	    print "</para>
  ";

  	}

  	print "</refsect1>
  ";

      }
  }
  
  # output function in XML DocBook
  sub output_function_xml(%) {
      my %args = %{$_[0]};
      my ($parameter, $section);
      my $count;
      my $id;

      $id = "API-" . $args{'function'};

      $id =~ s/[^A-Za-z0-9]/-/g;

      print "<refentry id=\"$id\">
  ";

      print "<refentryinfo>
  ";
      print " <title>LINUX</title>
  ";
      print " <productname>Kernel Hackers Manual</productname>
  ";
      print " <date>$man_date</date>
  ";
      print "</refentryinfo>
  ";

      print "<refmeta>
  ";

      print " <refentrytitle><phrase>" . $args{'function'} . "</phrase></refentrytitle>
  ";

      print " <manvolnum>9</manvolnum>
  ";

      print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>
  ";

      print "</refmeta>
  ";
      print "<refnamediv>
  ";

      print " <refname>" . $args{'function'} . "</refname>
  ";

      print " <refpurpose>
  ";
      print "  ";
      output_highlight ($args{'purpose'});
      print " </refpurpose>
  ";
      print "</refnamediv>
  ";
  
      print "<refsynopsisdiv>
  ";
      print " <title>Synopsis</title>
  ";
      print "  <funcsynopsis><funcprototype>
  ";

      print "   <funcdef>" . $args{'functiontype'} . " ";
      print "<function>" . $args{'function'} . " </function></funcdef>
  ";

  
      $count = 0;
      if ($#{$args{'parameterlist'}} >= 0) {
  	foreach $parameter (@{$args{'parameterlist'}}) {
  	    $type = $args{'parametertypes'}{$parameter};
  	    if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
  		# pointer-to-function
  		print "   <paramdef>$1<parameter>$parameter</parameter>)
  ";
  		print "     <funcparams>$2</funcparams></paramdef>
  ";
  	    } else {

  		print "   <paramdef>" . $type;

  		print " <parameter>$parameter</parameter></paramdef>
  ";
  	    }
  	}
      } else {

  	print "  <void/>
  ";

      }
      print "  </funcprototype></funcsynopsis>
  ";
      print "</refsynopsisdiv>
  ";
  
      # print parameters
      print "<refsect1>
   <title>Arguments</title>
  ";
      if ($#{$args{'parameterlist'}} >= 0) {
  	print " <variablelist>
  ";
  	foreach $parameter (@{$args{'parameterlist'}}) {
  	    my $parameter_name = $parameter;
  	    $parameter_name =~ s/\[.*//;

  	    $type = $args{'parametertypes'}{$parameter};

  	    print "  <varlistentry>
     <term><parameter>$type $parameter</parameter></term>
  ";

  	    print "   <listitem>
      <para>
  ";
  	    $lineprefix="     ";
  	    output_highlight($args{'parameterdescs'}{$parameter_name});
  	    print "    </para>
     </listitem>
    </varlistentry>
  ";
  	}
  	print " </variablelist>
  ";
      } else {
  	print " <para>
    None
   </para>
  ";
      }
      print "</refsect1>
  ";
  
      output_section_xml(@_);
      print "</refentry>
  
  ";
  }
  
  # output struct in XML DocBook
  sub output_struct_xml(%) {
      my %args = %{$_[0]};
      my ($parameter, $section);
      my $id;

      $id = "API-struct-" . $args{'struct'};

      $id =~ s/[^A-Za-z0-9]/-/g;

      print "<refentry id=\"$id\">
  ";

      print "<refentryinfo>
  ";
      print " <title>LINUX</title>
  ";
      print " <productname>Kernel Hackers Manual</productname>
  ";
      print " <date>$man_date</date>
  ";
      print "</refentryinfo>
  ";

      print "<refmeta>
  ";

      print " <refentrytitle><phrase>" . $args{'type'} . " " . $args{'struct'} . "</phrase></refentrytitle>
  ";

      print " <manvolnum>9</manvolnum>
  ";

      print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>
  ";

      print "</refmeta>
  ";
      print "<refnamediv>
  ";

      print " <refname>" . $args{'type'} . " " . $args{'struct'} . "</refname>
  ";

      print " <refpurpose>
  ";
      print "  ";
      output_highlight ($args{'purpose'});
      print " </refpurpose>
  ";
      print "</refnamediv>
  ";
  
      print "<refsynopsisdiv>
  ";
      print " <title>Synopsis</title>
  ";
      print "  <programlisting>
  ";

      print $args{'type'} . " " . $args{'struct'} . " {
  ";

      foreach $parameter (@{$args{'parameterlist'}}) {
  	if ($parameter =~ /^#/) {

  	    my $prm = $parameter;
  	    # convert data read & converted thru xml_escape() into &xyz; format:
  	    # This allows us to have #define macros interspersed in a struct.
  	    $prm =~ s/\\\\\\/\&/g;
  	    print "$prm
  ";

  	    next;
  	}
  
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;
  
  	defined($args{'parameterdescs'}{$parameter_name}) || next;

  	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;

  	$type = $args{'parametertypes'}{$parameter};
  	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
  	    # pointer-to-function
  	    print "  $1 $parameter) ($2);
  ";
  	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {

  	    # bitfield

  	    print "  $1 $parameter$2;
  ";
  	} else {

  	    print "  " . $type . " " . $parameter . ";
  ";

  	}
      }
      print "};";
      print "  </programlisting>
  ";
      print "</refsynopsisdiv>
  ";
  
      print " <refsect1>
  ";
      print "  <title>Members</title>
  ";

      if ($#{$args{'parameterlist'}} >= 0) {

      print "  <variablelist>
  ";
      foreach $parameter (@{$args{'parameterlist'}}) {
        ($parameter =~ /^#/) && next;
  
        my $parameter_name = $parameter;
        $parameter_name =~ s/\[.*//;
  
        defined($args{'parameterdescs'}{$parameter_name}) || next;
        ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;

        $type = $args{'parametertypes'}{$parameter};

        print "    <varlistentry>";

        print "      <term><literal>$type $parameter</literal></term>
  ";

        print "      <listitem><para>
  ";
        output_highlight($args{'parameterdescs'}{$parameter_name});
        print "      </para></listitem>
  ";
        print "    </varlistentry>
  ";
      }
      print "  </variablelist>
  ";

      } else {
  	print " <para>
    None
   </para>
  ";
      }

      print " </refsect1>
  ";
  
      output_section_xml(@_);
  
      print "</refentry>
  
  ";
  }
  
  # output enum in XML DocBook
  sub output_enum_xml(%) {
      my %args = %{$_[0]};
      my ($parameter, $section);
      my $count;
      my $id;

      $id = "API-enum-" . $args{'enum'};

      $id =~ s/[^A-Za-z0-9]/-/g;

      print "<refentry id=\"$id\">
  ";

      print "<refentryinfo>
  ";
      print " <title>LINUX</title>
  ";
      print " <productname>Kernel Hackers Manual</productname>
  ";
      print " <date>$man_date</date>
  ";
      print "</refentryinfo>
  ";

      print "<refmeta>
  ";

      print " <refentrytitle><phrase>enum " . $args{'enum'} . "</phrase></refentrytitle>
  ";

      print " <manvolnum>9</manvolnum>
  ";

      print " <refmiscinfo class=\"version\">" . $kernelversion . "</refmiscinfo>
  ";

      print "</refmeta>
  ";
      print "<refnamediv>
  ";

      print " <refname>enum " . $args{'enum'} . "</refname>
  ";

      print " <refpurpose>
  ";
      print "  ";
      output_highlight ($args{'purpose'});
      print " </refpurpose>
  ";
      print "</refnamediv>
  ";
  
      print "<refsynopsisdiv>
  ";
      print " <title>Synopsis</title>
  ";
      print "  <programlisting>
  ";

      print "enum " . $args{'enum'} . " {
  ";

      $count = 0;
      foreach $parameter (@{$args{'parameterlist'}}) {

  	print "  $parameter";
  	if ($count != $#{$args{'parameterlist'}}) {

  	    $count++;
  	    print ",";

  	}

  	print "
  ";
      }
      print "};";
      print "  </programlisting>
  ";
      print "</refsynopsisdiv>
  ";
  
      print "<refsect1>
  ";

      print " <title>Constants</title>
  ";

      print "  <variablelist>
  ";
      foreach $parameter (@{$args{'parameterlist'}}) {
        my $parameter_name = $parameter;
        $parameter_name =~ s/\[.*//;
  
        print "    <varlistentry>";
        print "      <term>$parameter</term>
  ";
        print "      <listitem><para>
  ";
        output_highlight($args{'parameterdescs'}{$parameter_name});
        print "      </para></listitem>
  ";
        print "    </varlistentry>
  ";
      }
      print "  </variablelist>
  ";
      print "</refsect1>
  ";
  
      output_section_xml(@_);
  
      print "</refentry>
  
  ";
  }
  
  # output typedef in XML DocBook
  sub output_typedef_xml(%) {
      my %args = %{$_[0]};
      my ($parameter, $section);
      my $id;

      $id = "API-typedef-" . $args{'typedef'};

      $id =~ s/[^A-Za-z0-9]/-/g;

      print "<refentry id=\"$id\">
  ";

      print "<refentryinfo>
  ";
      print " <title>LINUX</title>
  ";
      print " <productname>Kernel Hackers Manual</productname>
  ";
      print " <date>$man_date</date>
  ";
      print "</refentryinfo>
  ";

      print "<refmeta>
  ";

      print " <refentrytitle><phrase>typedef " . $args{'typedef'} . "</phrase></refentrytitle>
  ";

      print " <manvolnum>9</manvolnum>
  ";

      print "</refmeta>
  ";
      print "<refnamediv>
  ";

      print " <refname>typedef " . $args{'typedef'} . "</refname>
  ";

      print " <refpurpose>
  ";
      print "  ";
      output_highlight ($args{'purpose'});
      print " </refpurpose>
  ";
      print "</refnamediv>
  ";
  
      print "<refsynopsisdiv>
  ";
      print " <title>Synopsis</title>
  ";

      print "  <synopsis>typedef " . $args{'typedef'} . ";</synopsis>
  ";

      print "</refsynopsisdiv>
  ";
  
      output_section_xml(@_);
  
      print "</refentry>
  
  ";
  }
  
  # output in XML DocBook

  sub output_blockhead_xml(%) {

      my %args = %{$_[0]};
      my ($parameter, $section);
      my $count;
  
      my $id = $args{'module'};
      $id =~ s/[^A-Za-z0-9]/-/g;
  
      # print out each section
      $lineprefix="   ";
      foreach $section (@{$args{'sectionlist'}}) {

  	if (!$args{'content-only'}) {
  		print "<refsect1>
   <title>$section</title>
  ";
  	}

  	if ($section =~ m/EXAMPLE/i) {
  	    print "<example><para>
  ";

  	    $output_preformatted = 1;

  	} else {
  	    print "<para>
  ";

  	}
  	output_highlight($args{'sections'}{$section});

  	$output_preformatted = 0;

  	if ($section =~ m/EXAMPLE/i) {
  	    print "</para></example>
  ";

  	} else {
  	    print "</para>";
  	}
  	if (!$args{'content-only'}) {
  		print "
  </refsect1>
  ";

  	}

      }
  
      print "
  
  ";
  }
  
  # output in XML DocBook
  sub output_function_gnome {
      my %args = %{$_[0]};
      my ($parameter, $section);
      my $count;
      my $id;

      $id = $args{'module'} . "-" . $args{'function'};

      $id =~ s/[^A-Za-z0-9]/-/g;
  
      print "<sect2>
  ";

      print " <title id=\"$id\">" . $args{'function'} . "</title>
  ";

  
      print "  <funcsynopsis>
  ";

      print "   <funcdef>" . $args{'functiontype'} . " ";
      print "<function>" . $args{'function'} . " ";

      print "</function></funcdef>
  ";
  
      $count = 0;
      if ($#{$args{'parameterlist'}} >= 0) {
  	foreach $parameter (@{$args{'parameterlist'}}) {
  	    $type = $args{'parametertypes'}{$parameter};
  	    if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
  		# pointer-to-function
  		print "   <paramdef>$1 <parameter>$parameter</parameter>)
  ";
  		print "     <funcparams>$2</funcparams></paramdef>
  ";
  	    } else {

  		print "   <paramdef>" . $type;

  		print " <parameter>$parameter</parameter></paramdef>
  ";
  	    }
  	}
      } else {
  	print "  <void>
  ";
      }
      print "  </funcsynopsis>
  ";
      if ($#{$args{'parameterlist'}} >= 0) {
  	print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">
  ";
  	print "<tgroup cols=\"2\">
  ";
  	print "<colspec colwidth=\"2*\">
  ";
  	print "<colspec colwidth=\"8*\">
  ";
  	print "<tbody>
  ";
  	foreach $parameter (@{$args{'parameterlist'}}) {
  	    my $parameter_name = $parameter;
  	    $parameter_name =~ s/\[.*//;
  
  	    print "  <row><entry align=\"right\"><parameter>$parameter</parameter></entry>
  ";
  	    print "   <entry>
  ";
  	    $lineprefix="     ";
  	    output_highlight($args{'parameterdescs'}{$parameter_name});
  	    print "    </entry></row>
  ";
  	}
  	print " </tbody></tgroup></informaltable>
  ";
      } else {
  	print " <para>
    None
   </para>
  ";
      }
  
      # print out each section
      $lineprefix="   ";
      foreach $section (@{$args{'sectionlist'}}) {
  	print "<simplesect>
   <title>$section</title>
  ";
  	if ($section =~ m/EXAMPLE/i) {
  	    print "<example><programlisting>
  ";

  	    $output_preformatted = 1;

  	} else {
  	}
  	print "<para>
  ";
  	output_highlight($args{'sections'}{$section});

  	$output_preformatted = 0;

  	print "</para>
  ";
  	if ($section =~ m/EXAMPLE/i) {
  	    print "</programlisting></example>
  ";
  	} else {
  	}
  	print " </simplesect>
  ";
      }
  
      print "</sect2>
  
  ";
  }
  
  ##
  # output function in man
  sub output_function_man(%) {
      my %args = %{$_[0]};
      my ($parameter, $section);
      my $count;
  
      print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX
  ";
  
      print ".SH NAME
  ";

      print $args{'function'} . " \\- " . $args{'purpose'} . "
  ";

  
      print ".SH SYNOPSIS
  ";

      if ($args{'functiontype'} ne "") {

  	print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "
  ";

      } else {

  	print ".B \"" . $args{'function'} . "
  ";

      }

      $count = 0;
      my $parenth = "(";
      my $post = ",";
      foreach my $parameter (@{$args{'parameterlist'}}) {
  	if ($count == $#{$args{'parameterlist'}}) {
  	    $post = ");";
  	}
  	$type = $args{'parametertypes'}{$parameter};
  	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
  	    # pointer-to-function

  	    print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"
  ";

  	} else {
  	    $type =~ s/([^\*])$/$1 /;

  	    print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"
  ";

  	}
  	$count++;
  	$parenth = "";
      }
  
      print ".SH ARGUMENTS
  ";
      foreach $parameter (@{$args{'parameterlist'}}) {
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;

  	print ".IP \"" . $parameter . "\" 12
  ";

  	output_highlight($args{'parameterdescs'}{$parameter_name});
      }
      foreach $section (@{$args{'sectionlist'}}) {
  	print ".SH \"", uc $section, "\"
  ";
  	output_highlight($args{'sections'}{$section});
      }
  }
  
  ##
  # output enum in man
  sub output_enum_man(%) {
      my %args = %{$_[0]};
      my ($parameter, $section);
      my $count;
  
      print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX
  ";
  
      print ".SH NAME
  ";

      print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "
  ";

  
      print ".SH SYNOPSIS
  ";

      print "enum " . $args{'enum'} . " {
  ";

      $count = 0;
      foreach my $parameter (@{$args{'parameterlist'}}) {

  	print ".br
  .BI \"    $parameter\"
  ";

  	if ($count == $#{$args{'parameterlist'}}) {
  	    print "
  };
  ";
  	    last;
  	}
  	else {
  	    print ", 
  .br
  ";
  	}
  	$count++;
      }
  
      print ".SH Constants
  ";
      foreach $parameter (@{$args{'parameterlist'}}) {
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;

  	print ".IP \"" . $parameter . "\" 12
  ";

  	output_highlight($args{'parameterdescs'}{$parameter_name});
      }
      foreach $section (@{$args{'sectionlist'}}) {
  	print ".SH \"$section\"
  ";
  	output_highlight($args{'sections'}{$section});
      }
  }
  
  ##
  # output struct in man
  sub output_struct_man(%) {
      my %args = %{$_[0]};
      my ($parameter, $section);

      print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX
  ";

  
      print ".SH NAME
  ";

      print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "
  ";

  
      print ".SH SYNOPSIS
  ";

      print $args{'type'} . " " . $args{'struct'} . " {
  .br
  ";

  
      foreach my $parameter (@{$args{'parameterlist'}}) {
  	if ($parameter =~ /^#/) {
  	    print ".BI \"$parameter\"
  .br
  ";
  	    next;
  	}
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;

  	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;

  	$type = $args{'parametertypes'}{$parameter};
  	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
  	    # pointer-to-function

  	    print ".BI \"    " . $1 . "\" " . $parameter . " \") (" . $2 . ")" . "\"
  ;
  ";

  	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {

  	    # bitfield

  	    print ".BI \"    " . $1 . "\ \" " . $parameter . $2 . " \"" . "\"
  ;
  ";

  	} else {
  	    $type =~ s/([^\*])$/$1 /;

  	    print ".BI \"    " . $type . "\" " . $parameter . " \"" . "\"
  ;
  ";

  	}
  	print "
  .br
  ";
      }
      print "};
  .br
  ";

      print ".SH Members
  ";

      foreach $parameter (@{$args{'parameterlist'}}) {
  	($parameter =~ /^#/) && next;
  
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;

  	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;

  	print ".IP \"" . $parameter . "\" 12
  ";

  	output_highlight($args{'parameterdescs'}{$parameter_name});
      }
      foreach $section (@{$args{'sectionlist'}}) {
  	print ".SH \"$section\"
  ";
  	output_highlight($args{'sections'}{$section});
      }
  }
  
  ##
  # output typedef in man
  sub output_typedef_man(%) {
      my %args = %{$_[0]};
      my ($parameter, $section);
  
      print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX
  ";
  
      print ".SH NAME
  ";

      print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "
  ";

  
      foreach $section (@{$args{'sectionlist'}}) {
  	print ".SH \"$section\"
  ";
  	output_highlight($args{'sections'}{$section});
      }
  }

  sub output_blockhead_man(%) {

      my %args = %{$_[0]};
      my ($parameter, $section);
      my $count;
  
      print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX
  ";
  
      foreach $section (@{$args{'sectionlist'}}) {
  	print ".SH \"$section\"
  ";
  	output_highlight($args{'sections'}{$section});
      }
  }
  
  ##
  # output in text
  sub output_function_text(%) {
      my %args = %{$_[0]};
      my ($parameter, $section);

      my $start;

      print "Name:
  
  ";

      print $args{'function'} . " - " . $args{'purpose'} . "
  ";

  
      print "
  Synopsis:
  
  ";

      if ($args{'functiontype'} ne "") {

  	$start = $args{'functiontype'} . " " . $args{'function'} . " (";

      } else {

  	$start = $args{'function'} . " (";

      }

      print $start;

      my $count = 0;
      foreach my $parameter (@{$args{'parameterlist'}}) {
  	$type = $args{'parametertypes'}{$parameter};
  	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
  	    # pointer-to-function

  	    print $1 . $parameter . ") (" . $2;

  	} else {

  	    print $type . " " . $parameter;

  	}
  	if ($count != $#{$args{'parameterlist'}}) {
  	    $count++;
  	    print ",
  ";
  	    print " " x length($start);
  	} else {
  	    print ");
  
  ";
  	}
      }
  
      print "Arguments:
  
  ";
      foreach $parameter (@{$args{'parameterlist'}}) {
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;

  	print $parameter . "
  \t" . $args{'parameterdescs'}{$parameter_name} . "
  ";

      }
      output_section_text(@_);
  }
  
  #output sections in text
  sub output_section_text(%) {
      my %args = %{$_[0]};
      my $section;
  
      print "
  ";
      foreach $section (@{$args{'sectionlist'}}) {
  	print "$section:
  
  ";
  	output_highlight($args{'sections'}{$section});

      }

      print "
  
  ";
  }
  
  # output enum in text
  sub output_enum_text(%) {
      my %args = %{$_[0]};
      my ($parameter);
      my $count;
      print "Enum:
  
  ";

      print "enum " . $args{'enum'} . " - " . $args{'purpose'} . "
  
  ";
      print "enum " . $args{'enum'} . " {
  ";

      $count = 0;
      foreach $parameter (@{$args{'parameterlist'}}) {

  	print "\t$parameter";

  	if ($count != $#{$args{'parameterlist'}}) {
  	    $count++;
  	    print ",";
  	}
  	print "
  ";
      }
      print "};
  
  ";
  
      print "Constants:
  
  ";
      foreach $parameter (@{$args{'parameterlist'}}) {
  	print "$parameter
  \t";

  	print $args{'parameterdescs'}{$parameter} . "
  ";

      }
  
      output_section_text(@_);
  }
  
  # output typedef in text
  sub output_typedef_text(%) {
      my %args = %{$_[0]};
      my ($parameter);
      my $count;
      print "Typedef:
  
  ";

      print "typedef " . $args{'typedef'} . " - " . $args{'purpose'} . "
  ";

      output_section_text(@_);
  }
  
  # output struct as text
  sub output_struct_text(%) {
      my %args = %{$_[0]};
      my ($parameter);

      print $args{'type'} . " " . $args{'struct'} . " - " . $args{'purpose'} . "
  
  ";
      print $args{'type'} . " " . $args{'struct'} . " {
  ";

      foreach $parameter (@{$args{'parameterlist'}}) {
  	if ($parameter =~ /^#/) {
  	    print "$parameter
  ";
  	    next;
  	}
  
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;

  	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;

  	$type = $args{'parametertypes'}{$parameter};
  	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
  	    # pointer-to-function
  	    print "\t$1 $parameter) ($2);
  ";
  	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {

  	    # bitfield

  	    print "\t$1 $parameter$2;
  ";
  	} else {

  	    print "\t" . $type . " " . $parameter . ";
  ";

  	}
      }
      print "};
  
  ";
  
      print "Members:
  
  ";
      foreach $parameter (@{$args{'parameterlist'}}) {
  	($parameter =~ /^#/) && next;
  
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;

  	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;

  	print "$parameter
  \t";

  	print $args{'parameterdescs'}{$parameter_name} . "
  ";

      }
      print "
  ";
      output_section_text(@_);
  }

  sub output_blockhead_text(%) {

      my %args = %{$_[0]};
      my ($parameter, $section);
  
      foreach $section (@{$args{'sectionlist'}}) {
  	print " $section:
  ";
  	print "    -> ";
  	output_highlight($args{'sections'}{$section});
      }
  }

  ##
  # output in restructured text
  #
  
  #
  # This could use some work; it's used to output the DOC: sections, and
  # starts by putting out the name of the doc section itself, but that tends
  # to duplicate a header already in the template file.
  #
  sub output_blockhead_rst(%) {
      my %args = %{$_[0]};
      my ($parameter, $section);
  
      foreach $section (@{$args{'sectionlist'}}) {

  	if ($output_selection != OUTPUT_INCLUDE) {
  	    print "**$section**
  
  ";
  	}

          print_lineno($section_start_lines{$section});

  	output_highlight_rst($args{'sections'}{$section});
  	print "
  ";
      }
  }
  
  sub output_highlight_rst {
      my $contents = join "
  ",@_;
      my $line;
  
      # undo the evil effects of xml_escape() earlier
      $contents = xml_unescape($contents);
  
      eval $dohighlight;
      die $@ if $@;
  
      foreach $line (split "
  ", $contents) {

  	print $lineprefix . $line . "
  ";

      }
  }
  
  sub output_function_rst(%) {
      my %args = %{$_[0]};
      my ($parameter, $section);

      my $oldprefix = $lineprefix;

      my $start = "";
  
      if ($args{'typedef'}) {
  	print ".. c:type:: ". $args{'function'} . "
  
  ";
  	print_lineno($declaration_start_line);
  	print "   **Typedef**: ";
  	$lineprefix = "";
  	output_highlight_rst($args{'purpose'});
  	$start = "
  
  **Syntax**
  
    ``";
      } else {
  	print ".. c:function:: ";
      }

      if ($args{'functiontype'} ne "") {

  	$start .= $args{'functiontype'} . " " . $args{'function'} . " (";

      } else {

  	$start .= $args{'function'} . " (";

      }
      print $start;
  
      my $count = 0;
      foreach my $parameter (@{$args{'parameterlist'}}) {
  	if ($count ne 0) {
  	    print ", ";
  	}
  	$count++;
  	$type = $args{'parametertypes'}{$parameter};

  	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
  	    # pointer-to-function
  	    print $1 . $parameter . ") (" . $2;
  	} else {
  	    print $type . " " . $parameter;
  	}
      }

      if ($args{'typedef'}) {
  	print ");``
  
  ";
      } else {
  	print ")
  
  ";
  	print_lineno($declaration_start_line);
  	$lineprefix = "   ";
  	output_highlight_rst($args{'purpose'});
  	print "
  ";
      }

      print "**Parameters**
  
  ";
      $lineprefix = "  ";

      foreach $parameter (@{$args{'parameterlist'}}) {
  	my $parameter_name = $parameter;

  	$parameter_name =~ s/\[.*//;

  	$type = $args{'parametertypes'}{$parameter};
  
  	if ($type ne "") {

  	    print "``$type $parameter``
  ";

  	} else {

  	    print "``$parameter``
  ";

  	}

  
          print_lineno($parameterdesc_start_lines{$parameter_name});

  	if (defined($args{'parameterdescs'}{$parameter_name}) &&
  	    $args{'parameterdescs'}{$parameter_name} ne $undescribed) {

  	    output_highlight_rst($args{'parameterdescs'}{$parameter_name});

  	} else {

  	    print "  *undescribed*
  ";

  	}
  	print "
  ";
      }

  
      $lineprefix = $oldprefix;

      output_section_rst(@_);
  }
  
  sub output_section_rst(%) {
      my %args = %{$_[0]};
      my $section;
      my $oldprefix = $lineprefix;

      $lineprefix = "";

  
      foreach $section (@{$args{'sectionlist'}}) {

  	print "**$section**
  
  ";

          print_lineno($section_start_lines{$section});

  	output_highlight_rst($args{'sections'}{$section});
  	print "
  ";
      }
      print "
  ";
      $lineprefix = $oldprefix;
  }
  
  sub output_enum_rst(%) {
      my %args = %{$_[0]};
      my ($parameter);

      my $oldprefix = $lineprefix;

      my $count;

      my $name = "enum " . $args{'enum'};

  
      print "
  
  .. c:type:: " . $name . "
  
  ";

      print_lineno($declaration_start_line);

      $lineprefix = "   ";
      output_highlight_rst($args{'purpose'});
      print "
  ";

      print "**Constants**
  
  ";
      $lineprefix = "  ";

      foreach $parameter (@{$args{'parameterlist'}}) {

  	print "``$parameter``
  ";

  	if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
  	    output_highlight_rst($args{'parameterdescs'}{$parameter});
  	} else {

  	    print "  *undescribed*
  ";

  	}
  	print "
  ";
      }

      $lineprefix = $oldprefix;
      output_section_rst(@_);
  }
  
  sub output_typedef_rst(%) {
      my %args = %{$_[0]};
      my ($parameter);

      my $oldprefix = $lineprefix;

      my $name = "typedef " . $args{'typedef'};

      print "
  
  .. c:type:: " . $name . "
  
  ";

      print_lineno($declaration_start_line);

      $lineprefix = "   ";
      output_highlight_rst($args{'purpose'});
      print "
  ";

      $lineprefix = $oldprefix;

      output_section_rst(@_);
  }
  
  sub output_struct_rst(%) {
      my %args = %{$_[0]};
      my ($parameter);

      my $oldprefix = $lineprefix;

      my $name = $args{'type'} . " " . $args{'struct'};

      print "
  
  .. c:type:: " . $name . "
  
  ";

      print_lineno($declaration_start_line);

      $lineprefix = "   ";
      output_highlight_rst($args{'purpose'});
      print "
  ";

      print "**Definition**
  
  ";
      print "::
  
  ";

      print "  " . $args{'type'} . " " . $args{'struct'} . " {
  ";
      foreach $parameter (@{$args{'parameterlist'}}) {
  	if ($parameter =~ /^#/) {

  	    print "  " . "$parameter
  ";

  	    next;
  	}
  
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;
  
  	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
  	$type = $args{'parametertypes'}{$parameter};
  	if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
  	    # pointer-to-function
  	    print "    $1 $parameter) ($2);
  ";
  	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {
  	    # bitfield
  	    print "    $1 $parameter$2;
  ";
  	} else {
  	    print "    " . $type . " " . $parameter . ";
  ";
  	}
      }
      print "  };
  
  ";

      print "**Members**
  
  ";
      $lineprefix = "  ";

      foreach $parameter (@{$args{'parameterlist'}}) {
  	($parameter =~ /^#/) && next;
  
  	my $parameter_name = $parameter;
  	$parameter_name =~ s/\[.*//;
  
  	($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
  	$type = $args{'parametertypes'}{$parameter};

          print_lineno($parameterdesc_start_lines{$parameter_name});

  	print "``" . $parameter . "``
  ";

  	output_highlight_rst($args{'parameterdescs'}{$parameter_name});

  	print "
  ";
      }
      print "
  ";

  
      $lineprefix = $oldprefix;

      output_section_rst(@_);
  }

  ## list mode output functions
  
  sub output_function_list(%) {
      my %args = %{$_[0]};
  
      print $args{'function'} . "
  ";
  }
  
  # output enum in list
  sub output_enum_list(%) {
      my %args = %{$_[0]};
      print $args{'enum'} . "
  ";
  }
  
  # output typedef in list
  sub output_typedef_list(%) {
      my %args = %{$_[0]};
      print $args{'typedef'} . "
  ";
  }
  
  # output struct as list
  sub output_struct_list(%) {
      my %args = %{$_[0]};
  
      print $args{'struct'} . "
  ";
  }
  
  sub output_blockhead_list(%) {
      my %args = %{$_[0]};
      my ($parameter, $section);
  
      foreach $section (@{$args{'sectionlist'}}) {
  	print "DOC: $section
  ";
      }
  }

  ##

  # generic output function for all types (function, struct/union, typedef, enum);
  # calls the generated, variable output_ function name based on
  # functype and output_mode

  sub output_declaration {
      no strict 'refs';
      my $name = shift;
      my $functype = shift;
      my $func = "output_${functype}_$output_mode";

      if (($output_selection == OUTPUT_ALL) ||
  	(($output_selection == OUTPUT_INCLUDE ||
  	  $output_selection == OUTPUT_EXPORTED) &&
  	 defined($function_table{$name})) ||
  	(($output_selection == OUTPUT_EXCLUDE ||
  	  $output_selection == OUTPUT_INTERNAL) &&
  	 !($functype eq "function" && defined($function_table{$name}))))

      {

  	&$func(@_);

  	$section_counter++;
      }
  }
  
  ##

  # generic output function - calls the right one based on current output mode.

  sub output_blockhead {

      no strict 'refs';

      my $func = "output_blockhead_" . $output_mode;

      &$func(@_);
      $section_counter++;
  }
  
  ##

  # takes a declaration (struct, union, enum, typedef) and

  # invokes the right handler. NOT called for functions.
  sub dump_declaration($$) {
      no strict 'refs';
      my ($prototype, $file) = @_;

      my $func = "dump_" . $decl_type;

      &$func(@_);
  }
  
  sub dump_union($$) {
      dump_struct(@_);
  }
  
  sub dump_struct($$) {
      my $x = shift;
      my $file = shift;

      my $nested;

      if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) {
  	#my $decl_type = $1;

  	$declaration_name = $2;
  	my $members = $3;

  
  	# ignore embedded structs or unions

  	$members =~ s/({.*})//g;
  	$nested = $1;

  	# ignore members marked private:

  	$members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
  	$members =~ s/\/\*\s*private:.*//gosi;

  	# strip comments:
  	$members =~ s/\/\*.*?\*\///gos;

  	$nested =~ s/\/\*.*?\*\///gos;

  	# strip attributes