From 0f26c7c3d76af06f5a29f00a1c1bbf5fa85fd7b1 Mon Sep 17 00:00:00 2001
From: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Date: Fri, 11 Sep 2020 11:29:37 +0100
Subject: [PATCH] Bug 20582: (QA follow-up) Add POD to satisfy coding
 guidelines

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
---
 Koha/App/Intranet.pm          | 18 ++++++++++++++++++
 Koha/App/Opac.pm              | 18 ++++++++++++++++++
 Koha/App/Plugin/CGIBinKoha.pm | 18 ++++++++++++++++++
 Koha/App/Plugin/RESTV1.pm     | 18 ++++++++++++++++++
 4 files changed, 72 insertions(+)

diff --git a/Koha/App/Intranet.pm b/Koha/App/Intranet.pm
index d06c65260d..bf66e9e62b 100644
--- a/Koha/App/Intranet.pm
+++ b/Koha/App/Intranet.pm
@@ -73,3 +73,21 @@ sub _around_action {
 }
 
 1;
+
+=encoding utf8
+
+=head1 NAME
+
+Koha::App::Intranet - Mojolicious app for Koha's Intranet Client
+
+=head1 DESCRIPTION
+
+Run the Koha Intranet using Mojolicious servers
+
+=head1 METHODS
+
+=head2 startup
+
+Called at application startup; Sets up routes, loads plugins and invokes hooks.
+
+=cut
diff --git a/Koha/App/Opac.pm b/Koha/App/Opac.pm
index 89ff94c5ec..7af85e1515 100644
--- a/Koha/App/Opac.pm
+++ b/Koha/App/Opac.pm
@@ -73,3 +73,21 @@ sub _around_action {
 }
 
 1;
+
+=encoding utf8
+
+=head1 NAME
+
+Koha::App::Opac - Mojolicious app for Koha's Opac Client
+
+=head1 DESCRIPTION
+
+Run the Koha Opac using Mojolicious servers
+
+=head1 METHODS
+
+=head2 startup
+
+Called at application startup; Sets up routes, loads plugins and invokes hooks.
+
+=cut
diff --git a/Koha/App/Plugin/CGIBinKoha.pm b/Koha/App/Plugin/CGIBinKoha.pm
index 197e9f70f1..6c07743630 100644
--- a/Koha/App/Plugin/CGIBinKoha.pm
+++ b/Koha/App/Plugin/CGIBinKoha.pm
@@ -98,3 +98,21 @@ sub _psgi_env {
 }
 
 1;
+
+=encoding utf8
+
+=head1 NAME
+
+Koha::App::Plugin::CGIBinKoha
+
+=head1 DESCRIPTION
+
+Koha App Plugin used to wrap Koha CGI scripts for backwards compatibility whilst we migrate from CGI to using the Mojolicious Web Application Framework.
+
+=head1 METHODS
+
+=head2 register
+
+Called at application startup; Sets up a catch-all router to identify CGI scripts and loads the found script using CGI::Compile before running it under CGI::Emulate::PSGI.
+
+=cut
diff --git a/Koha/App/Plugin/RESTV1.pm b/Koha/App/Plugin/RESTV1.pm
index 63e2a8d536..7ff62beecf 100644
--- a/Koha/App/Plugin/RESTV1.pm
+++ b/Koha/App/Plugin/RESTV1.pm
@@ -30,3 +30,21 @@ sub register {
 }
 
 1;
+
+=encoding utf8
+
+=head1 NAME
+
+Koha::App::Plugin::RESTV1
+
+=head1 DESCRIPTION
+
+Koha App Plugin used to intercept api calls and route them to the dedicated REST API Mojolicious App.
+
+=head1 METHODS
+
+=head2 register
+
+Called at application startup; Sets up a router to catch all calls to /api and pass them through to Koha::REST::V1.
+
+=cut
-- 
2.11.4.GIT