Bug 20402: Add missing POD

[srvgit] / Koha / OAuth.pm

diff --git a/Koha/OAuth.pm b/Koha/OAuth.pm
index 6966570..e322206 100644 (file)
--- a/Koha/OAuth.pm
+++ b/Koha/OAuth.pm
@@ -1,8 +1,39 @@
 package Koha::OAuth;
 
+# This file is part of Koha.
+#
+# Koha is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 3 of the License, or (at your option) any later
+# version.
+#
+# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
 use Modern::Perl;
+
 use Koha::OAuthAccessTokens;
-use Koha::OAuthAccessToken;
+
+=head1 NAME
+
+Koha::OAuth - Koha library for OAuth2 callbacks
+
+=head1 API
+
+=head2 Class methods
+
+=head3 config
+
+    my $config = Koha::OAuth->config;
+
+Returns a hashref containing the callbacks Net::OAuth2::AuthorizationServer requires
+
+=cut
 
 sub config {
     return {
@@ -12,6 +43,13 @@ sub config {
     };
 }
 
+=head3 _verify_client_db
+
+A callback to verify if the client asking for authorization is known to the authorization server
+and allowed to get authorization.
+
+=cut
+
 sub _verify_client_cb {
     my (%args) = @_;
 
@@ -30,6 +68,12 @@ sub _verify_client_cb {
     return (1, undef, []);
 }
 
+=head3 _store_access_token_cb
+
+A callback to store the generated access tokens.
+
+=cut
+
 sub _store_access_token_cb {
     my ( %args ) = @_;
 
@@ -46,6 +90,12 @@ sub _store_access_token_cb {
     return;
 }
 
+=head3 _verify_access_token_cb
+
+A callback to verify the access token.
+
+=cut
+
 sub _verify_access_token_cb {
     my (%args) = @_;