CPAN not extracting documentation

Do you have a question? Post it now! No Registration Necessary.  Now with pictures!

Threaded View


I just loaded a new module onto CPAN, and I've obviously done something
wrong, because my POD documentation isn't shown properly on CPAN.

The extracted htmlified documentation is not representative on what is
actualy in the .pm files (the main Viso file, as well as the other .pm

Any ideas on what I may be doing wrong.

(yes i I admit, even the current documentation needs some work, but I
wanted to run thru the process first)

Thanks for any help.

Re: CPAN not extracting documentation


Aamer Akhter wrote:
Quoted text here. Click to load it

Yes the POD documentation is wrong. I suggest to look into a module
which documentation looks good in CPAN, e.g.

As I can see:
ABSTRACT, DESCRIPTION having only the default documntation, generated by
For function documentation I use:

=over 4

=item new(..)

=item otherfunc


Also a good idea: perldoc perlpod


Quoted text here. Click to load it


Re: CPAN not extracting documentation


Quoted text here. Click to load it

Thanks for responding...

I looked at your module and I think something wierd is going on with
respect to the document generation.

If you look at the source at:

and the generated documentation at:

You'll notice that I do have the NAME, SYNOPSIS and the fucntions
filled out in the source documentation. But when the CPAN version is
generated, NAME is set to the h2x default.

It appears the CPAN is using the default pod documentation from one of
the sub-classes (Visio/ This class is actually documented in (as are the other classes).

For some reason the documentation in is not being picked. I
have tried  pod2html and it does work fine on

The tutorials refrencenced in the thread do not discuss the situation
with multi-file modules and how the documenation is extracted. Can
someone please send a pointer that explains what may be happening in my

Thanks much.

Quoted text here. Click to load it

Re: CPAN not extracting documentation

Quoted text here. Click to load it

It looks like CPAN is extracting the module name from

=head1 NAME

Visio - Perl extension mainpulating XML based Visio files

The other modules I had just cut and pasted the original h2x pod (and
retained the Visio name). This was confusing the CPAN extractor. I've
changed the NAME section under each of the modules such that they are
now unique, and this appears to work.

Quoted text here. Click to load it

Re: CPAN not extracting documentation

Aamer Akhter wrote:
Quoted text here. Click to load it
That was not a wise choice.  Uploading your file to CPAN should follow
creation of code, tests and documentation.  Not only does your
documentation not look good; your module has failed all its tests:

Please see the Perl documentation, especially:

    perldoc perlnewmod

.... which is also available online at .  Tutorials for writing
CPAN-ready modules are available in a number of places, including

Site Timeline