From 7c44560375d7c79d40d988d21600e2afd0784254 Mon Sep 17 00:00:00 2001
From: Demian Katz <demian.katz@villanova.edu>
Date: Wed, 18 Sep 2019 15:58:34 -0400
Subject: [PATCH] Clean up comments. - Fix typos and questionable/malformed
 @see references.

---
 module/VuFind/src/VuFind/Cache/Manager.php                    | 2 +-
 module/VuFind/src/VuFind/Session/SecureDelegator.php          | 4 ++--
 .../VuFindSearch/src/VuFindSearch/Backend/Solr/Connector.php  | 4 ++--
 .../src/VuFindSearch/Backend/Solr/LuceneSyntaxHelper.php      | 2 +-
 .../src/VuFindSearch/Backend/Solr/QueryBuilder.php            | 2 +-
 .../Backend/Solr/Response/Json/RecordCollection.php           | 2 +-
 module/VuFindSearch/src/VuFindSearch/Query/QueryGroup.php     | 2 +-
 7 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/module/VuFind/src/VuFind/Cache/Manager.php b/module/VuFind/src/VuFind/Cache/Manager.php
index 80dcde82166..e455992190e 100644
--- a/module/VuFind/src/VuFind/Cache/Manager.php
+++ b/module/VuFind/src/VuFind/Cache/Manager.php
@@ -123,7 +123,7 @@ class Manager
      *
      * @param string      $name      Name of the requested cache.
      * @param string|null $namespace Optional namespace to use. Defaults to the
-     * value of {@see $name}.
+     * value of $name.
      *
      * @return StorageInterface
      * @throws \Exception
diff --git a/module/VuFind/src/VuFind/Session/SecureDelegator.php b/module/VuFind/src/VuFind/Session/SecureDelegator.php
index 8425c42fba1..6ae95a1efeb 100644
--- a/module/VuFind/src/VuFind/Session/SecureDelegator.php
+++ b/module/VuFind/src/VuFind/Session/SecureDelegator.php
@@ -69,8 +69,8 @@ class SecureDelegator
     /**
      * SecureDelegator constructor.
      *
-     * @param CookieManager    $cookieManager {@see $cookieHandler}
-     * @param HandlerInterface $handler       {@see $handler}
+     * @param CookieManager    $cookieManager VuFind cookie manager service.
+     * @param HandlerInterface $handler       The wrapped session handler.
      */
     public function __construct(
         CookieManager $cookieManager, HandlerInterface $handler
diff --git a/module/VuFindSearch/src/VuFindSearch/Backend/Solr/Connector.php b/module/VuFindSearch/src/VuFindSearch/Backend/Solr/Connector.php
index 5b175d86f62..2075717d888 100644
--- a/module/VuFindSearch/src/VuFindSearch/Backend/Solr/Connector.php
+++ b/module/VuFindSearch/src/VuFindSearch/Backend/Solr/Connector.php
@@ -66,9 +66,9 @@ class Connector implements \Zend\Log\LoggerAwareInterface
     /**
      * Maximum length of a GET url.
      *
-     * Switches to POST if the SOLR target URL exeeds this length.
+     * Switches to POST if the SOLR target URL exceeds this length.
      *
-     * @see self::query()
+     * @see \VuFindSearch\Backend\Solr\Connector::query()
      *
      * @var int
      */
diff --git a/module/VuFindSearch/src/VuFindSearch/Backend/Solr/LuceneSyntaxHelper.php b/module/VuFindSearch/src/VuFindSearch/Backend/Solr/LuceneSyntaxHelper.php
index 8b139cd908f..89dd7ef53b5 100644
--- a/module/VuFindSearch/src/VuFindSearch/Backend/Solr/LuceneSyntaxHelper.php
+++ b/module/VuFindSearch/src/VuFindSearch/Backend/Solr/LuceneSyntaxHelper.php
@@ -626,7 +626,7 @@ class LuceneSyntaxHelper
      *
      * @return string
      *
-     * @see self::capitalizeRanges
+     * @see \VuFindSearch\Backend\Solr\LuceneSyntaxHelper::capitalizeRanges()
      *
      * @todo Check possible problem with umlauts/non-ASCII word characters
      */
diff --git a/module/VuFindSearch/src/VuFindSearch/Backend/Solr/QueryBuilder.php b/module/VuFindSearch/src/VuFindSearch/Backend/Solr/QueryBuilder.php
index cfaee9c6b32..d846dd55fc2 100644
--- a/module/VuFindSearch/src/VuFindSearch/Backend/Solr/QueryBuilder.php
+++ b/module/VuFindSearch/src/VuFindSearch/Backend/Solr/QueryBuilder.php
@@ -332,7 +332,7 @@ class QueryBuilder implements QueryBuilderInterface
      *
      * @return string
      *
-     * @see self::reduceQueryGroup()
+     * @see \VuFindSearch\Backend\Solr\QueryBuilder::reduceQueryGroup()
      */
     protected function reduceQueryGroupComponents(AbstractQuery $component)
     {
diff --git a/module/VuFindSearch/src/VuFindSearch/Backend/Solr/Response/Json/RecordCollection.php b/module/VuFindSearch/src/VuFindSearch/Backend/Solr/Response/Json/RecordCollection.php
index cd08495e0aa..fbfbafac924 100644
--- a/module/VuFindSearch/src/VuFindSearch/Backend/Solr/Response/Json/RecordCollection.php
+++ b/module/VuFindSearch/src/VuFindSearch/Backend/Solr/Response/Json/RecordCollection.php
@@ -44,7 +44,7 @@ class RecordCollection extends AbstractRecordCollection
     /**
      * Template of deserialized SOLR response.
      *
-     * @see self::__construct()
+     * @see \VuFindSearch\Backend\Solr\Response\Json\RecordCollection::__construct()
      *
      * @var array
      */
diff --git a/module/VuFindSearch/src/VuFindSearch/Query/QueryGroup.php b/module/VuFindSearch/src/VuFindSearch/Query/QueryGroup.php
index d0d503f5783..0182d1b2f73 100644
--- a/module/VuFindSearch/src/VuFindSearch/Query/QueryGroup.php
+++ b/module/VuFindSearch/src/VuFindSearch/Query/QueryGroup.php
@@ -51,7 +51,7 @@ class QueryGroup extends AbstractQuery
     /**
      * Name of the handler to be used if the query group is reduced.
      *
-     * @see VuFindSearch\Backend\Solr\QueryBuilder::reduceQueryGroup()
+     * @see \VuFindSearch\Backend\Solr\QueryBuilder::reduceQueryGroup()
      *
      * @var string
      *
-- 
GitLab