Bug 1953 [6/6]: adding pod documentation for C4::Koha::displayServers
authorAndrew Moore <andrew.moore@liblime.com>
Tue, 29 Jul 2008 16:42:50 +0000 (11:42 -0500)
committerJoshua Ferraro <jmf@liblime.com>
Wed, 30 Jul 2008 08:45:24 +0000 (03:45 -0500)
This method was not documented. I added some POD to it.

Signed-off-by: Galen Charlton <galen.charlton@liblime.com>
Signed-off-by: Joshua Ferraro <jmf@liblime.com>
C4/Koha.pm

index 7f5bb68..846af3e 100644 (file)
@@ -887,6 +887,37 @@ SELECT lib,
     return \%notforloan_label_of;
 }
 
+=head2 displayServers
+
+=over 4
+
+my $servers = displayServers();
+
+my $servers = displayServers( $position );
+
+my $servers = displayServers( $position, $type );
+
+=back
+
+displayServers returns a listref of hashrefs, each containing
+information about available z3950 servers. Each hashref has a format
+like:
+
+    {
+      'checked'    => 'checked',
+      'encoding'   => 'MARC-8'
+      'icon'       => undef,
+      'id'         => 'LIBRARY OF CONGRESS',
+      'label'      => '',
+      'name'       => 'server',
+      'opensearch' => '',
+      'value'      => 'z3950.loc.gov:7090/',
+      'zed'        => 1,
+    },
+
+
+=cut
+
 sub displayServers {
     my ( $position, $type ) = @_;
     my $dbh = C4::Context->dbh;