Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

go back to standard pod name section

  • Loading branch information...
commit 389ede9b1c281905eabb766edf11d2d9ee9e07ee 1 parent f30a3b9
@jonswar authored
View
1  dist.ini
@@ -1,4 +1,5 @@
name = CHI
+abstract = Unified cache handling interface
main_module = lib/CHI.pm
author = Jonathan Swartz <swartz@pobox.com>
license = Perl_5
View
5 lib/CHI.pm
@@ -81,10 +81,13 @@ sub new {
1;
__END__
-# ABSTRACT: Unified cache handling interface
=pod
+=head1 NAME
+
+CHI - Unified cache handling interface
+
=head1 SYNOPSIS
use CHI;
View
5 lib/CHI/CacheObject.pm
@@ -143,11 +143,14 @@ sub value {
1;
-# ABSTRACT: Contains information about cache entries
__END__
=pod
+=head1 NAME
+
+CHI::CacheObject - Contains information about cache entries
+
=head1 SYNOPSIS
my $object = $cache->get_object($key);
View
5 lib/CHI/Constants.pm
@@ -15,11 +15,14 @@ use constant CHI_Max_Time => 0xffffffff;
1;
-# ABSTRACT: Internal constants
__END__
=pod
+=head1 NAME
+
+CHI::Constants - Internal constants
+
=head1 DESCRIPTION
These are constants for internal CHI use.
View
5 lib/CHI/Driver.pm
@@ -609,10 +609,13 @@ sub _describe_cache_set {
1;
__END__
-# ABSTRACT: Base class for all CHI drivers
=pod
+=head1 NAME
+
+CHI::Driver - Base class for all CHI drivers
+
=head1 DESCRIPTION
This is the base class that all CHI drivers inherit from. It provides the
View
5 lib/CHI/Driver/Base/CacheContainer.pm
@@ -50,10 +50,13 @@ sub get_namespaces {
1;
__END__
-# ABSTRACT: Caches that delegate to a contained cache
=pod
+=head1 NAME
+
+CHI::Driver::Base::CacheContainer - Caches that delegate to a contained cache
+
=head1 DESCRIPTION
Role for CHI drivers with an internal '_contained_cache' slot that itself
View
5 lib/CHI/Driver/CacheCache.pm
@@ -35,10 +35,13 @@ sub _build_contained_cache {
1;
__END__
-#ABSTRACT: CHI wrapper for Cache::Cache
=pod
+=head1 NAME
+
+CHI::Driver::CacheCache - CHI wrapper for Cache::Cache
+
=head1 SYNOPSIS
use CHI;
View
5 lib/CHI/Driver/FastMmap.pm
@@ -77,10 +77,13 @@ sub store {
1;
__END__
-# ABSTRACT: Shared memory interprocess cache via mmap'ed files
=pod
+=head1 NAME
+
+CHI::Driver::FastMmap - Shared memory interprocess cache via mmap'ed files
+
=head1 SYNOPSIS
use CHI;
View
10 lib/CHI/Driver/File.pm
@@ -16,13 +16,13 @@ use warnings;
extends 'CHI::Driver';
+has '+max_key_length' => ( default => 248 );
has 'depth' => ( is => 'ro', isa => 'Int', default => 2 );
has 'dir_create_mode' => ( is => 'ro', isa => 'Int', default => oct(775) );
has 'file_create_mode' => ( is => 'ro', isa => 'Int', default => oct(666) );
has 'file_extension' => ( is => 'ro', isa => 'Str', default => '.dat' );
-has '+max_key_length' => ( default => 248 );
-has 'root_dir' => ( is => 'ro', isa => 'Str', default => catdir( tmpdir(), 'chi-driver-file' ) );
has 'path_to_namespace' => ( is => 'ro', lazy => 1, builder => '_build_path_to_namespace' );
+has 'root_dir' => ( is => 'ro', isa => 'Str', default => catdir( tmpdir(), 'chi-driver-file' ) );
__PACKAGE__->meta->make_immutable();
@@ -234,10 +234,14 @@ sub path_to_key {
1;
__END__
-# ABSTRACT: File-based cache using one file per entry in a multi-level directory structure
=pod
+=head1 NAME
+
+CHI::Driver::File - File-based cache using one file per entry in a multi-level
+directory structure
+
=head1 SYNOPSIS
use CHI;
View
5 lib/CHI/Driver/Memory.pm
@@ -93,10 +93,13 @@ sub discard_policy_lru {
1;
__END__
-# ABSTRACT: In-process memory based cache
=pod
+=head1 NAME
+
+CHI::Driver::Memory - In-process memory based cache
+
=head1 SYNOPSIS
use CHI;
View
7 lib/CHI/Driver/Metacache.pm
@@ -5,8 +5,8 @@ use strict;
use warnings;
has 'meta_cache' => ( is => 'ro', builder => '_build_meta_cache' );
-has 'owner_namespace' => ( is => 'ro', lazy_build => 1 );
has 'owner_cache' => ( is => 'ro', weak_ref => 1 );
+has 'owner_namespace' => ( is => 'ro', lazy_build => 1 );
__PACKAGE__->meta->make_immutable;
@@ -54,10 +54,13 @@ sub _prefixed_key {
1;
__END__
-# ABSTRACT: metacache for internal CHI use
=pod
+=head1 NAME
+
+CHI::Driver::Metacache - Metacache for internal CHI use
+
=head1 SYNOPSIS
$cache->metacache->get($meta_key);
View
5 lib/CHI/Driver/Null.pm
@@ -16,10 +16,13 @@ sub get_namespaces { return () }
1;
__END__
-# ABSTRACT: nothing is cached
=pod
+=head1 NAME
+
+CHI::Driver::Null - Nothing is cached
+
=head1 SYNOPSIS
use CHI;
View
1  lib/CHI/Driver/Role/Universal.pm
@@ -22,7 +22,6 @@ around 'remove' => sub {
1;
__END__
-# ABSTRACT: Universal role applied as the innermost role to all CHI drivers
=pod
View
5 lib/CHI/Stats.pm
@@ -125,10 +125,13 @@ sub clear {
1;
__END__
-# ABSTRACT: Record and report per-namespace cache statistics
=pod
+=head1 NAME
+
+CHI::Stats - Record and report per-namespace cache statistics
+
=head1 SYNOPSIS
# Turn on statistics collection
View
1  lib/CHI/Util.pm
@@ -174,4 +174,3 @@ sub has_moose_class {
1;
__END__
-# ABSTRACT: Utilities for internal CHI use
View
2  weaver.ini
@@ -1,5 +1,5 @@
[@CorePrep]
-[Name]
+[Generic / NAME]
[Version]
[Generic / SYNOPSIS]
[Generic / DESCRIPTION]
Please sign in to comment.
Something went wrong with that request. Please try again.