Bug 22544: Clarify documentation and change param 'type' to 'location'

[koha-ffzg.git] / Koha / Caches.pm

diff --git a/Koha/Caches.pm b/Koha/Caches.pm
index 52f1812..8940925 100644 (file)
--- a/Koha/Caches.pm
+++ b/Koha/Caches.pm
@@ -15,11 +15,36 @@ package Koha::Caches;
 # You should have received a copy of the GNU General Public License
 # along with Koha; if not, see <http://www.gnu.org/licenses>.
 
+=head1 NAME
+
+Koha::Caches - Cache handling
+
+=head1 SYNOPSIS
+
+my $cache = Koha::Caches->get_instance();
+
+=head1 DESCRIPTION
+
+Description
+
+=head1 CLASS METHODS
+
+=cut
+
 use Modern::Perl;
 
 use Koha::Cache;
 
 our $singleton_caches;
+
+=head2 get_instance
+
+This gets a shared instance of the cache, set up in a very default way. This is
+the recommended way to fetch a cache object. If possible, it'll be
+persistent across multiple instances.
+
+=cut
+
 sub get_instance {
     my ($class, $subnamespace) = @_;
     $subnamespace //= '';
@@ -28,6 +53,10 @@ sub get_instance {
     return $singleton_caches->{$subnamespace};
 }
 
+=head2 flush_L1_caches
+
+=cut
+
 sub flush_L1_caches {
     return unless $singleton_caches;
     for my $cache ( values %$singleton_caches ) {