Skip to content

Commit

Permalink
Added DB class overview documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nigelhorne committed Feb 23, 2018
1 parent 313bda2 commit ff58268
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions lib/Geo/Coder/Free/DB.pm
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,18 @@ package Geo::Coder::Free::DB;
# must apply in writing for a licence for use from Nigel Horne at the
# above e-mail.

# Read-only access to databases
# Abstract class giving read-only access to CSV, XML and SQLite databases

# You can then access the files in $directory/foo.csv via this class:

# package MyPackageName::DB::foo;

# use Geo::Coder::Free::DB

# our @ISA = ('Geo::Coder::Free::DB');

# 1;


use warnings;
use strict;
Expand Down Expand Up @@ -44,9 +55,9 @@ sub new {

return bless {
logger => $args{'logger'} || $logger,
directory => $args{'directory'} || $directory,
directory => $args{'directory'} || $directory, # The directory conainting the tables in XML, SQLite or CSV format
cache => $args{'cache'} || $cache,
table => $args{'table'}
table => $args{'table'} # The name of the file containing the table, defaults to the class name
}, $class;
}

Expand Down

0 comments on commit ff58268

Please sign in to comment.