• NAME
• SYNOPSIS
• DESCRIPTION
• SEE ALSO
• COPYRIGHT
• AUTHOR

NAME

Pod::PseudoPod::Index -- format PseudoPod index entries

SYNOPSIS

  use Pod::PseudoPod::Index;

  my $parser = Pod::PseudoPod::Index->new();

  $parser->parse_file('path/to/file1.pod');
  $parser->parse_file('path/to/file2.pod');

  $parser->output_text;

DESCRIPTION

This class is a formatter that extracts index items from PseudoPod files and renders them as plain text or html.

This is a subclass of Pod::PseudoPod and inherits all its methods.

SEE ALSO

Pod::PseudoPod

COPYRIGHT

Copyright (c) 2004 Allison Randal. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.

AUTHOR

Allison Randal <allison@perl.org>

                    cpanm Pod::PseudoPod::Index

                    perl -MCPAN -e shell
                    install Pod::PseudoPod::Index