From cd1456b8cbec1e26a617dab085a4871f50e94022 Mon Sep 17 00:00:00 2001
From: Demian Katz <demian.katz@villanova.edu>
Date: Fri, 1 Mar 2013 11:45:51 -0500
Subject: [PATCH] Cleaned up comments.

---
 module/VuFind/src/VuFind/OAI/Server.php | 99 +++++++++++++++++++++----
 1 file changed, 86 insertions(+), 13 deletions(-)

diff --git a/module/VuFind/src/VuFind/OAI/Server.php b/module/VuFind/src/VuFind/OAI/Server.php
index 708b9ed793a..a3feb3583d1 100644
--- a/module/VuFind/src/VuFind/OAI/Server.php
+++ b/module/VuFind/src/VuFind/OAI/Server.php
@@ -42,29 +42,102 @@ use SimpleXMLElement,
  */
 class Server
 {
-    protected $baseURL;                         // Repository base URL
-    protected $params;                          // Incoming request parameters
-    protected $searchClassId = 'Solr';          // Search object class to use
-    protected $core = 'biblio';                 // What Solr core are we serving up?
-    protected $iso8601 = 'Y-m-d\TH:i:s\Z';      // ISO-8601 date format
-    protected $pageSize = 100;                  // Records per page in lists
-    protected $setField = null;                 // Solr field for set membership
-
-    // Supported metadata formats:
+    /**
+     * Repository base URL
+     *
+     * @var string
+     */
+    protected $baseURL;
+
+    /**
+     * Incoming request parameters
+     *
+     * @var array
+     */
+    protected $params;
+
+    /**
+     * Search object class to use
+     *
+     * @var string
+     */
+    protected $searchClassId = 'Solr';
+
+    /**
+     * What Solr core are we serving up?
+     *
+     * @var string
+     */
+    protected $core = 'biblio';
+
+    /**
+     * ISO-8601 date format
+     *
+     * @var string
+     */
+    protected $iso8601 = 'Y-m-d\TH:i:s\Z';
+
+    /**
+     * Records per page in lists
+     *
+     * @var int
+     */
+    protected $pageSize = 100;
+
+    /**
+     * Solr field for set membership
+     *
+     * @var string
+     */
+    protected $setField = null;
+
+    /**
+     * Supported metadata formats
+     *
+     * @var array
+     */
     protected $metadataFormats = array();
 
-    // Namespace used for ID prefixing (if any):
+    /**
+     * Namespace used for ID prefixing (if any)
+     *
+     * @var string
+     */
     protected $idNamespace = null;
 
-    // Values used in "Identify" response:
+    /**
+     * Repository name used in "Identify" response
+     *
+     * @var string
+     */
     protected $repositoryName = 'VuFind';
+
+    /**
+     * Earliest datestamp used in "Identify" response
+     *
+     * @var string
+     */
     protected $earliestDatestamp = '2000-01-01T00:00:00Z';
+
+    /**
+     * Admin email used in "Identify" response
+     *
+     * @var string
+     */
     protected $adminEmail;
 
-    // Search manager:
+    /**
+     * Search manager
+     *
+     * @var \VuFind\Search\Manager
+     */
     protected $searchManager;
 
-    // Table manager:
+    /**
+     * Table manager
+     *
+     * @var \VuFind\Db\Table\PluginManager
+     */
     protected $tableManager;
 
     /**
-- 
GitLab