The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Perldoc::Writer - base class for stream output functions

SYNOPSIS

 # using - generally use a subclass
 my $writer = Perldoc::Writer::XML->new();

 $doc->receiver($writer);
 $doc->send_all();

 my $output = $writer->output;  # an IO::All object

 # or, you can pass an object or specify an IO::All source
 $writer->output("filename");
 $writer->output(\$scalar);

 # to get the document body
 $writer->doc;

DESCRIPTION

A writer is something that takes Perldoc Serial API events, and converts them into a stream.