diff options
author | Daniel Friesel <derf@derf.homelinux.org> | 2009-07-01 17:12:03 +0200 |
---|---|---|
committer | Daniel Friesel <derf@derf.homelinux.org> | 2009-07-01 17:12:03 +0200 |
commit | c51a300c48dda3b29b7268debbd41e319d719147 (patch) | |
tree | 0ebccd4e508a94043e4237b347b69f12180df477 /lib | |
parent | af809de1fd377fa61edb1887a5cac1756bda3e72 (diff) |
Simplestore: Added some documentation
Diffstat (limited to 'lib')
-rwxr-xr-x | lib/Simplestore.pm | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/lib/Simplestore.pm b/lib/Simplestore.pm index 7885449..1369d87 100755 --- a/lib/Simplestore.pm +++ b/lib/Simplestore.pm @@ -43,3 +43,55 @@ sub save { } 1; + +__END__ + +=head1 NAME + +Simplestore - simple storage format for hash refs + +=head1 SYNOPSIS + + + use Simplestore; + + # somefile contains: + # word purrl + # foo eggs + my $hash = load('somefile'); + say $hash->{word}; # purrl + + $hash->{foo} = 'bar'; + $hash->{word} = "Yeah, this is more thon one\nword, I know"; + save('somefile', $hash); + + # somefile contains: + # word Yeah, this is more than one + # word word, I know + # foo bar + +=head1 DESCRIPTION + +B<Simplestore> is a perl library to store hashes in a very simple, +easy-to-parse file format. + +=head1 FUNCTIONS + +=over + +=item B<load>(I<store file> [, I<hashref>]) + +Load the hash saved in I<store file>. Returns a hash ref containing the hash +saved in I<store file>. + +If I<hashref> is specified, I<store file> will not be loaded into an empty hash, +but into I<hashref>. However, keys in I<store file> overwrite those in I<hashref>. + +=item B<save>(I<store file>, I<hashref>) + +save I<hashref> in I<store file>. Returns nothing. + +=head1 COPYRIGHT + +Copyright (C) 2009 by Daniel Friesel. +Licensed under the terms of the WTFPL <http://sam.zoy.org/wtfpl>. |