Pod::ROBODoc - Convert ROBODoc to Pod.
use Pod::ROBODoc; my $parser = Pod::ROBODoc->new(); $parser->convert( input => '/path/to/inputfile', output => '/path/to/outputfile, );
Pod::ROBODoc is a simple ROBODoc-to-Pod converter.
new creates a Pod::ROBODoc object. Options are passed as name-value pairs.
Boolean indicating whether to keep data found within ROBODoc SOURCE tags. Defaults to false.
Boolean indicating whether to strip out whitespace-only lines from ROBODoc. Defaults to false.
Reference to an array of custom ROBODoc tag names. Defaults to an empty list.
filter takes an input stream containing ROBODoc documentation, converts it to Pod, and writes it to the output stream.
The input stream containing ROBODoc documentation. If specified, this must be a file name. Defaults to STDIN.
The output stream to which the Pod will be written. If specified, this must be a file name. Defaults to STDOUT.
convert takes a string containing ROBODoc documentation, converts it to Pod, and returns the Pod string.
The input string containing ROBODoc documentation.
Please report any bugs or feature requests to
bug-Pod-ROBODoc at rt dot cpan dot org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Robodoc. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
You may also use this module's github issues tracker at http://github.com/mgrimm/Pod-ROBODoc/issues.
There is currently no support for using filehandles as input and output streams. This is planned for a future release.
This module was inspired by the following post: http://www.perlmonks.org/?node_id=536298
Much of the module design and test suite were adapted from elements of Pod::WikiDoc.
mgrimm at cpan dot org
Copyright 2010, Matt Grimm, All rights reserved
This software is available under the same terms as perl.