Meta::Pdmt::Handlers::PerlPod - PDMT module to handle pod files.


Meta documentation Contained in the Meta distribution.

Index


Code Index:

NAME

Top

Meta::Pdmt::Handlers::PerlPod - PDMT module to handle pod files.

COPYRIGHT

Top

LICENSE

Top

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

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. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

DETAILS

Top

	MANIFEST: PerlPod.pm
	PROJECT: meta
	VERSION: 0.01

SYNOPSIS

Top

	package foo;
	use Meta::Pdmt::Handlers::PerlPod qw();
	my($object)=Meta::Pdmt::Handlers::PerlPod->new();
	my($result)=$object->method();

DESCRIPTION

Top

This module is a PDMT handler for POD files (Plain Old Documentation).

FUNCTIONS

Top

	new($)
	method($)
	TEST($)

FUNCTION DOCUMENTATION

Top

new($)

This is a constructor for the Meta::Pdmt::Handlers::PerlPod object.

method($)

This is an object method.

TEST($)

This is a testing suite for the Meta::Pdmt::Handlers::PerlPod module. This test is should be run by a higher level management system at integration or release time or just as a regular routine to check that all is well.

SUPER CLASSES

Top

Meta::Pdmt::Handler(3)

BUGS

Top

None.

AUTHOR

Top

	Name: Mark Veltzer
	Email: mailto:veltzer@cpan.org
	WWW: http://www.veltzer.org
	CPAN id: VELTZER

HISTORY

Top

	0.00 MV teachers project
	0.01 MV md5 issues

SEE ALSO

Top

Meta::Lang::Perl::Perl(3), Meta::Pdmt::Handler(3), Meta::Pdmt::Nodes::PerlPod(3), strict(3)

TODO

Top

Nothing.


Meta documentation Contained in the Meta distribution.

#!/bin/echo This is a perl module and should not be run

package Meta::Pdmt::Handlers::PerlPod;

use strict qw(vars refs subs);
use Meta::Pdmt::Handler qw();
use Meta::Pdmt::Nodes::PerlPod qw();
use Meta::Lang::Perl::Perl qw();

our($VERSION,@ISA);
$VERSION="0.01";
@ISA=qw(Meta::Pdmt::Handler);

#sub add_node($$$);
#sub TEST($);

#__DATA__

sub add_node($$$) {
	my($self,$node,$graph)=@_;
	my($path)=$node->get_path();
	if(Meta::Lang::Perl::Perl::is_perl($path)) {
		my($new_file)="manx/".Meta::Utils::Utils::remove_suffix($path).".man";
		my($new_node)=Meta::Pdmt::Nodes::PerlPod->new();
		$new_node->set_name($new_file);
		$new_node->set_path($new_file);
		#Meta::Utils::Output::print("going to add vertex [".$new_file."]\n");
		$graph->add_vertex($new_node);
		#Meta::Utils::Output::print("going to add edge from [".$new_file."] to [".$path."]\n");
		$graph->add_edge($new_node,$node);
		#Meta::Utils::Output::print("finished adding edge\n");
		return(1);
	} else {
		return(0);
	}
}

sub TEST($) {
	my($context)=@_;
	return(1);
}

1;

__END__