From: Rob Kinyon Date: Tue, 5 Jan 2010 16:06:14 +0000 (-0500) Subject: Removed extraneous slashes from POD X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=1c62d370c15f8441e8a11593f9d34eef46ff821c;p=dbsrgits%2FDBM-Deep.git Removed extraneous slashes from POD --- diff --git a/Changes b/Changes index b3991fb..7f1a918 100644 --- a/Changes +++ b/Changes @@ -10,6 +10,7 @@ Revision history for DBM::Deep. - Storage::DBI now detects between the two DBDs - (RT #51888) Applied POD patch (Thanks, FWIE!) - (RT #44981) Added VERSION to ::Array, ::Engine, and ::Hash + - Removed extraneous slashes from POD links (Thanks ilmari!) 1.0019_001 Dec 31 22:00:00 2009 EST (This is the first developer release for 1.0020.) diff --git a/lib/DBM/Deep/Engine.pm b/lib/DBM/Deep/Engine.pm index 1cd0362..a42850c 100644 --- a/lib/DBM/Deep/Engine.pm +++ b/lib/DBM/Deep/Engine.pm @@ -24,8 +24,8 @@ DBM::Deep::Engine =head1 PURPOSE -This is an internal-use-only object for L. It mediates the low-level -mapping between the L objects and the storage medium. +This is an internal-use-only object for L. It mediates the low-level +mapping between the L objects and the storage medium. The purpose of this documentation is to provide low-level documentation for developers. It is B intended to be used by the general public. This @@ -168,7 +168,7 @@ sub delete_key { die "delete_key must be implemented in a child class" } =head2 write_value( $obj, $key, $value ) This takes an object that provides _base_offset(), a string for the -key, and a value. This value can be anything storable within L. +key, and a value. This value can be anything storable within L. This returns 1 upon success. diff --git a/lib/DBM/Deep/Engine/File.pm b/lib/DBM/Deep/Engine/File.pm index f5145c4..47c233a 100644 --- a/lib/DBM/Deep/Engine/File.pm +++ b/lib/DBM/Deep/Engine/File.pm @@ -43,7 +43,7 @@ DBM::Deep::Engine::File =head1 PURPOSE -This is the engine for use with L. +This is the engine for use with L. =head1 EXTERNAL METHODS diff --git a/lib/DBM/Deep/Iterator.pm b/lib/DBM/Deep/Iterator.pm index 1082983..ee6e25f 100644 --- a/lib/DBM/Deep/Iterator.pm +++ b/lib/DBM/Deep/Iterator.pm @@ -14,7 +14,7 @@ DBM::Deep::Iterator =head1 PURPOSE -This is an internal-use-only object for L. It is the iterator +This is an internal-use-only object for L. It is the iterator for FIRSTKEY() and NEXTKEY(). =head1 OVERVIEW @@ -30,7 +30,7 @@ following elements: =over 4 -=item * engine (of type L +=item * engine (of type L =item * base_offset (the base_offset of the invoking DBM::Deep object) diff --git a/lib/DBM/Deep/Iterator/File/BucketList.pm b/lib/DBM/Deep/Iterator/File/BucketList.pm index d23a8ca..9ed9d9a 100644 --- a/lib/DBM/Deep/Iterator/File/BucketList.pm +++ b/lib/DBM/Deep/Iterator/File/BucketList.pm @@ -11,14 +11,14 @@ DBM::Deep::Iterator::BucketList =head1 PURPOSE -This is an internal-use-only object for L. It acts as the mediator -between the L object and a L +This is an internal-use-only object for L. It acts as the mediator +between the L object and a L sector. =head1 OVERVIEW This object, despite the implied class hiearchy, does B inherit from -L. Instead, it delegates to it, essentially acting as a +L. Instead, it delegates to it, essentially acting as a facade over it. L will instantiate one of these objects as needed to handle an BucketList sector. @@ -31,9 +31,9 @@ hashref is assumed to have the following elements: =over 4 -=item * iterator (of type L +=item * iterator (of type L -=item * sector (of type L +=item * sector (of type L =back diff --git a/lib/DBM/Deep/Iterator/File/Index.pm b/lib/DBM/Deep/Iterator/File/Index.pm index 6c7f815..543e524 100644 --- a/lib/DBM/Deep/Iterator/File/Index.pm +++ b/lib/DBM/Deep/Iterator/File/Index.pm @@ -11,14 +11,14 @@ DBM::Deep::Iterator::Index =head1 PURPOSE -This is an internal-use-only object for L. It acts as the mediator -between the L object and a L +This is an internal-use-only object for L. It acts as the mediator +between the L object and a L sector. =head1 OVERVIEW This object, despite the implied class hiearchy, does B inherit from -L. Instead, it delegates to it, essentially acting as a +L. Instead, it delegates to it, essentially acting as a facade over it. L will instantiate one of these objects as needed to handle an Index sector. @@ -31,9 +31,9 @@ hashref is assumed to have the following elements: =over 4 -=item * iterator (of type L +=item * iterator (of type L -=item * sector (of type L +=item * sector (of type L =back diff --git a/lib/DBM/Deep/Null.pm b/lib/DBM/Deep/Null.pm index df6dd05..4b41cdf 100644 --- a/lib/DBM/Deep/Null.pm +++ b/lib/DBM/Deep/Null.pm @@ -11,8 +11,8 @@ DBM::Deep::Null =head1 PURPOSE -This is an internal-use-only object for L. It acts as a NULL object -in the same vein as MARCEL's L. I couldn't use L +This is an internal-use-only object for L. It acts as a NULL object +in the same vein as MARCEL's L. I couldn't use L because DBM::Deep needed an object that always evaluated as undef, not an implementation of the Null Class pattern. diff --git a/lib/DBM/Deep/Storage.pm b/lib/DBM/Deep/Storage.pm index 78f8217..dea5f17 100644 --- a/lib/DBM/Deep/Storage.pm +++ b/lib/DBM/Deep/Storage.pm @@ -37,7 +37,7 @@ whole-file lock. In the future, more granular locking may be supported. The API for that is unclear right now. The following methods manage the locking status. In all cases, they take -a L object and returns nothing. +a L object and returns nothing. =over 4 diff --git a/lib/DBM/Deep/Storage/File.pm b/lib/DBM/Deep/Storage/File.pm index 2b80a5f..c2a7c7e 100644 --- a/lib/DBM/Deep/Storage/File.pm +++ b/lib/DBM/Deep/Storage/File.pm @@ -17,7 +17,7 @@ DBM::Deep::Storage::File =head1 PURPOSE -This is an internal-use-only object for L. It mediates the low-level +This is an internal-use-only object for L. It mediates the low-level interaction with the storage mechanism. Currently, the only storage mechanism supported is the file system.