Opened 8 years ago

Closed 8 years ago

#6571 closed enhancement (wontfix)

Geo::GDAL missing much detail

Reported by: Dan Jacobson Owned by: Ari Jolma
Priority: normal Milestone:
Component: PerlBindings Version: 2.1.0
Severity: normal Keywords:
Cc:

Description

http://help-site.com/Programming/Languages/Perl/CPAN/Data_Type_Utilities/Geo_Full/Geo-GDAL/GDAL.pod/

looks much longer than here on

libgdal-perl:
  Installed: 2.1.0+dfsg-3
  Candidate: 2.1.0+dfsg-3
  Version table:
 *** 2.1.0+dfsg-3 500
        500 http://free.nchc.org.tw/debian unstable/main i386 Packages
        100 /var/lib/dpkg/status

Have a look:

NAME
       Geo::GDAL - Perl extension for the GDAL library for geospatial data

SYNOPSIS
         use Geo::GDAL;

         my $raster_file = shift @ARGV;

         my $raster_dataset = Geo::GDAL::Open($file);

         my $raster_data = $dataset->GetRasterBand(1)->ReadTile;

         my $vector_datasource = Geo::OGR::Open('./');

         my $vector_layer = $datasource->Layer('borders'); # e.g. a shapefile borders.shp in current directory

         $vector_layer->ResetReading();
         while (my $feature = $vector_layer->GetNextFeature()) {
             my $geometry = $feature->GetGeometry();
             my $value = $feature->GetField($field);
         }

DESCRIPTION
       This Perl module lets you to manage (read, analyse, write) geospatial
       data stored in several formats.

   EXPORT
       None by default.

SEE ALSO
       The GDAL home page is <http://gdal.org/>

       The documentation of this module is written in Doxygen format. See
       <http://ajolma.net/Geo-GDAL/snapshot/>

AUTHOR
       Ari Jolma

COPYRIGHT AND LICENSE
       Copyright (C) 2005- by Ari Jolma and GDAL bindings developers.

Please unify them.

Maybe you are shipping an older version.

Change History (1)

comment:1 by Ari Jolma, 8 years ago

Resolution: wontfix
Status: newclosed

The page you link has probably some old version of the module documentation or somehow generated version of it. For example the more "official" Perl documentation pages https://metacpan.org/pod/Geo::GDAL and http://search.cpan.org/~ajolma/Geo-GDAL-2.010004/lib/Geo/GDAL.pm have the latter one.

The more complete documentation is written for Doxygen in separate files and I maintain an online copy of that. It used to require a patched version of a separate module. Now it should work fine with Doxygen::Filter::Perl but it still requires a perl program to prepare the .pm and .dox files for it. I don't think CPAN etc understand Doxygen.

If somebody can rework the docs so that they make up a set of regular Perl docs with the standard Perl workflow that would be great.

Note: See TracTickets for help on using tickets.