Changeset 542

Show
Ignore:
Timestamp:
05/04/07 10:05:22 (2 years ago)
Author:
hachi
Message:

Update docs and prepare for a release.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/api/xs/Cache-Memcached-GetParserXS/Makefile.PL

    r530 r542  
    1 use 5.008004; 
     1use 5.006; 
    22use ExtUtils::MakeMaker; 
    33# See lib/ExtUtils/MakeMaker.pm for details of how to influence 
    …… 
    1111              }, # e.g., Module::Name => 1.1 
    1212              ABSTRACT_FROM  => 'lib/Cache/Memcached/GetParserXS.pm', # retrieve abstract from module 
    13               AUTHOR         => 'LiveJournal user <lj@>', 
     13              AUTHOR         => 'Jonathan Steinert <hachi@cpan.org>', 
    1414              LIBS              => [''], # e.g., '-lm' 
    1515              DEFINE            => '', # e.g., '-DHAVE_SOMETHING' 

  • trunk/api/xs/Cache-Memcached-GetParserXS/lib/Cache/Memcached/GetParserXS.pm

    r530 r542  
    11package Cache::Memcached::GetParserXS; 
     2 
     3=head1 NAME 
     4 
     5Cache::Memcached::GetParserXS - GetParser implementation in XS for use with Cache::Memcached 
     6 
     7=head1 SYNOPSIS 
     8 
     9  use Cache::Memcached::GetParserXS; 
     10  use Cache::Memcached; 
     11 
     12  # Everything else is the same as Cache::Memcached has documented it. 
     13  # Seriously. 
     14 
     15=head1 DESCRIPTION 
     16 
     17This module implements the same function as Cache::Memcached::GetParser, except it's written 
     18in C/XS. Initial benchmarks have shown it to be possibly twice as fast as the original perl 
     19version. 
     20 
     21=cut 
    222 
    323use 5.006; 
    424use strict; 
    525use warnings; 
     26 
    627# We don't want to inherit from this, because our constants may be different. 
    728# use base 'Cache::Memcached::GetParser'; 
     29 
    830use Carp; 
    931use Errno qw( EINPROGRESS EWOULDBLOCK EISCONN ); 
    10 use AutoLoader; 
    1132use Cache::Memcached 1.21; 
    1233 
    …… 
    1451661; 
    146167__END__ 
    147 # Below is stub documentation for your module. You'd better edit it! 
    148  
    149 =head1 NAME 
    150  
    151 Cache::Memcached::GetParserXS - Perl extension for blah blah blah 
    152  
    153 =head1 SYNOPSIS 
    154  
    155   use Cache::Memcached::GetParserXS; 
    156   blah blah blah 
    157  
    158 =head1 DESCRIPTION 
    159  
    160 Stub documentation for Cache::Memcached::GetParserXS, created by h2xs. It looks like the 
    161 author of the extension was negligent enough to leave the stub 
    162 unedited. 
    163  
    164 Blah blah blah. 
    165  
    166 =head2 EXPORT 
    167  
    168 None by default. 
    169  
    170  
    171168 
    172169=head1 SEE ALSO 
    173170 
    174 Mention other useful documentation such as the documentation of 
    175 related modules or operating system documentation (such as man pages 
    176 in UNIX), or any relevant external documentation such as RFCs or 
    177 standards. 
     171Cache::Memcached 
    178172 
    179 If you have a mailing list set up for your module, mention it here. 
     173=head1 AUTHORS 
    180174 
    181 If you have a web site set up for your module, mention it here. 
     175Jonathan Steinert E<lt>hachi@cpan.orgE<gt> - Current maintainer 
    182176 
    183 =head1 AUTHOR 
     177Aaron Emigh 
    184178 
    185 LiveJournal user, E<lt>lj@E<gt> 
     179Brad Fitzpatrick 
    186180 
    187181=head1 COPYRIGHT AND LICENSE 
    188182 
    189 Copyright (C) 2006 by LiveJournal user 
     183Copyright (C) 2007 Six Apart Ltd. 
    190184 
    191185This library is free software; you can redistribute it and/or modify 
    …… 
    193187at your option, any later version of Perl 5 you may have available. 
    194188 
    195  
    196189=cut