[Gdal-dev] perldocs not being built and installed with 1.4.0?

[Ethan Alpert]

Thanks for the information I'll take a look this weekend. Is there a
version of perldoc that works with .dox files? If not it seems that lack
of .pods could be an issue for a lot of perl programmers as perldoc is
ubiquitously used and referenced.

-e

-----Original Message-----
From: Ari Jolma [mailto:ari.jolma at tkk.fi] 
Sent: Saturday, January 27, 2007 6:22 AM
To: Ethan Alpert
Cc: gdal-dev at lists.maptools.org
Subject: Re: [Gdal-dev] perldocs not being built and installed with
1.4.0?

Ethan Alpert kirjoitti:
> I'm not seeing anything in the Makefile that converts the .dox docs
into
> perldoc pods. The .dox files are being installed instead of .pod files
> into the perl directory structure.
>
> Is this a configuration problem on my side or a build bug?
>   

You may classify it as you wish but the docs are in the dox files. dox 
files are Doxygen files, doxygen is a source code documentation 
generator tool (http://www.stack.nl/~dimitri/doxygen/) which is used by 
other GDAL documentation. It can generate man pages but also HTML, 
LaTeX, etc. Doxygen does not directly support Perl but there is a Perl 
Doxygen Filter at http://www.bigsister.ch/doxygenfilter/ but to make 
life interesting, that filter is not directly usable in our case when we

have Swig generated Perl modules. For that purpose I modified 
doxygenfilter to add the capability to grab the docs for a module from 
an external file. The modified doxygenfilter is at 
http://map.hut.fi/files/doxygenfilter/ (I should perhaps advertise that 
a bit better somewhere). The HTML docs that I have generated from the 
dox are at http://map.hut.fi/doc/Geo-GDAL/html/ I haven't tried to 
generate the man pages.

I have informed the developers of doxygenfilter of my modifications.

There are no pod files anymore.

I recognise that the things are not very easy right now regarding the 
GDAL Perl docs, but at the same time I think that Doxygen is much better

than pod. If you have suggestions please let me know.

Ari

> -e
>
> _______________________________________________
> Gdal-dev mailing list
> Gdal-dev at lists.maptools.org
> http://lists.maptools.org/mailman/listinfo/gdal-dev
>   


-- 
Prof. Ari Jolma
Geoinformaatio- ja paikannustekniikka
Geoinformation and positioning technology
Teknillinen Korkeakoulu / Helsinki University of Technology
POBox 1200, 02015 TKK, Finland
Email: ari.jolma at tkk.fi URL: http://www.tkk.fi/~jolma