Perl6 Pod tree walker class
Perl6
Permalink
Failed to load latest commit information.
lib/Pod Make walk-pod accept any Iterable, not just an Array Dec 26, 2015
t Fix list handling when given objects not created by parsing Pod Dec 25, 2015
.gitignore
.travis.yml Add .travis.yml Nov 15, 2015
Changes.md Make walk-pod accept any Iterable, not just an Array Dec 26, 2015
LICENSE First pass at documentation Nov 15, 2015
META.info Make walk-pod accept any Iterable, not just an Array Dec 26, 2015
README.md Rename NodeWalker -> TreeWalker and NodeListener -> TreeWalker::Listener Dec 8, 2015

README.md

NAME

Pod::TreeWalker

Walk a Pod tree and generate an event for each node.

SYNOPSIS

my $to-html = Pod::To::HTML.new(...);
Pod::TreeWalker.new( :listener($to-html) ).walk-pod($=pod);

DESCRIPTION

This class provides an API for walking a pod tree (as provided by $=pod). Each node in the tree will trigger one or more events. These events cause methods to be called on a listener object that your provide. This lets you do something without a Pod document without having to know much about the underlying tree structure of Pod.

METHOD

Pod::TreeWalker.new( :listener( Pod::TreeWalker::Listener $object ) )

The constructor expects a single argument named listener. This object must implement the Pod::TreeWalker::Listener API.

METHOD

$walker.walk-pod($pod)

This method walks through a pod tree starting with the top node in $pod. You can provide either an array of pod nodes (as stored in $=pod) or a single top-level node (such as $=pod[0]).

AUTHOR

Dave Rolsky autarch@urth.org

COPYRIGHT

This software is copyright (c) 2015 by Dave Rolsky.

LICENSE

This is free software; you can redistribute it and/or modify it under the terms of The Artistic License 2.0.