File Coverage

blib/lib/Pod/Perldoc/ToToc.pm

Criterion	Covered	Total	%
statement	18	25	72.0
branch			n/a
condition			n/a
subroutine	6	10	60.0
pod	1	4	25.0
total	25	39	64.1

package Pod::Perldoc::ToToc;
use strict;
use parent qw(Pod::Perldoc::BaseTo);
use vars qw($VERSION);

use Pod::TOC;

use warnings;
no warnings;

$VERSION = '1.12';

sub is_pageable        { 1 }
sub write_with_binmode { 0 }
sub output_extension   { 'toc' }

sub parse_from_file {
	my( $self, $file, $output_fh ) = @_; # Pod::Perldoc object

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

	$parser->output_fh( $output_fh );

	$parser->parse_file( $file );
	}

=head1 NAME

Pod::Perldoc::ToToc - Translate Pod to a Table of Contents

=head1 SYNOPSIS

Use this module with C's C<-M> switch.

	% perldoc -MPod::Perldoc::ToToc Module::Name

=head1 DESCRIPTION

This module uses the C module to extract a table of
contents from a pod file.

=head1 METHODS

=over 4

=item parse_from_file( FILENAME, OUTPUT_FH )

Parse the file named in C using C and send the
results to the output filehandle C.

=back

=head1 SEE ALSO

L

=head1 SOURCE AVAILABILITY

This source is in Github:

	https://github.com/briandfoy/pod-perldoc-totoc

=head1 AUTHOR

brian d foy, C<<  >>

=head1 COPYRIGHT AND LICENSE

Copyright (c) 2006-2013, brian d foy, All Rights Reserved.

You may redistribute this under the same terms as Perl itself.

=cut

1;