Skip to content
RakuDoc tree walker class
  1. Other 100.0%
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.


Type Name Latest commit message Commit time
Failed to load latest commit information.
lib/Pod Add `use Pod::TreeWalker::Listener` for tests Dec 3, 2017
t Remove unused `allowed` attribute Nov 19, 2018
LICENSE First pass at documentation Nov 15, 2015
META6.json Rename NodeWalker -> TreeWalker and NodeListener -> TreeWalker::Listener Dec 8, 2015



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


my $to-html =; :listener($to-html) ).walk-pod($=pod);


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 :listener( Pod::TreeWalker::Listener $object ) )

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



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]).


Dave Rolsky


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


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

You can’t perform that action at this time.