Bug 19160: Add POD
authorKyle M Hall <kyle@bywatersolutions.com>
Fri, 2 Mar 2018 12:36:20 +0000 (12:36 +0000)
committerJonathan Druart <jonathan.druart@bugs.koha-community.org>
Fri, 23 Mar 2018 14:45:38 +0000 (11:45 -0300)
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
C4/Auth_with_cas.pm

index 2885caf..8cc8cde 100644 (file)
@@ -52,6 +52,10 @@ if (multipleAuth()) {
     $casservers = { 'default' => C4::Context->preference('casServerUrl') };
 }
 
+=head1 Subroutines
+
+=cut
+
 # Is there a configuration file for multiple cas servers?
 sub multipleAuth {
     return (-e qq($yamlauthfile));
@@ -228,7 +232,12 @@ sub _url_with_get_params {
     return $uri_base_part . $uri_params_part;
 }
 
-# CAS single logout
+=head2 logout_if_required
+
+    If using CAS, this subroutine will trigger single-signout of the CAS server.
+
+=cut
+
 sub logout_if_required {
     my ( $query ) = @_;
     # Check we havent been hit by a logout call