From: Mike Taylor Date: Mon, 8 Dec 2014 12:30:20 +0000 (+0000) Subject: Fix up inline documentation, such as it is. X-Git-Tag: v0.02~32 X-Git-Url: http://sru.miketaylor.org.uk/?a=commitdiff_plain;h=20b87b63a40109f295694e0de75d818adbb52689;p=perl-indexdata-utils.git Fix up inline documentation, such as it is. --- diff --git a/lib/IndexData/Utils.pm b/lib/IndexData/Utils.pm index 289dac6..7915ef7 100644 --- a/lib/IndexData/Utils.pm +++ b/lib/IndexData/Utils.pm @@ -12,48 +12,33 @@ __END__ =head1 NAME -IndexData::Utils - Perl extension for blah blah blah +IndexData::Utils - Utility Perl extension for Index Data applications =head1 SYNOPSIS use IndexData::Utils; - blah blah blah + # Use functions from the various submodules. =head1 DESCRIPTION -Stub documentation for IndexData::Utils, created by h2xs. It looks like the -author of the extension was negligent enough to leave the stub -unedited. - -Blah blah blah. - -=head2 EXPORT - -None by default. - - +This library contains utility functions that we at Index Data want to +share between multiple applications -- for example, the persistent +counter used by both IRSpy (see issue IR-350) and MKHome (IR-351). =head1 SEE ALSO -Mention other useful documentation such as the documentation of -related modules or operating system documentation (such as man pages -in UNIX), or any relevant external documentation such as RFCs or -standards. - -If you have a mailing list set up for your module, mention it here. - -If you have a web site set up for your module, mention it here. +IndexData::Utils::PersistentCounter =head1 AUTHOR -Mike Taylor, Emike@E +Mike Taylor, Emike@indexdata.comE =head1 COPYRIGHT AND LICENSE -Copyright (C) 2014 by Mike Taylor +Copyright (C) 2014 by Index Data. This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself, either Perl version 5.18.2 or, +it under the same terms as Perl itself, either Perl version 5.8.4 or, at your option, any later version of Perl 5 you may have available.