Glib::GenPod 1.160

SYNOPSIS

use Glib::GenPod;

# use the defaults:
xsdoc2pod ($xsdocparse_output_file, $destination_dir);

# or take matters into your own hands
require $xsdocparse_output_file;
foreach my $package (sort keys %$data) {
print "=head1 NAMEnn$packagenn";
print "=head1 METHODSnn" . podify_methods ($package) . "nn";
}

This module includes several utilities for creating pod for xs-based Perl modules which build on the Glib module's foundations. The most important bits are the logic to convert the data structures created by xsdocparse.pl to describe xsubs and pods into method docs, with call signatures and argument descriptions, and converting C type names into Perl type names. The rest of the module is mostly boiler-plate code to format and pretty-print information that may be queried from the Glib type system.

To make life easy for module maintainers, we also include a do-it-all function, xsdoc2pod(), which does pretty much everything for you. All of the pieces it uses are publically usable, so you can do whatever you like if you don't like the default output.

Product's homepage

Requirements:

· Perl