From 41b1380710547055613f88e2b25804f5c1290f67 Mon Sep 17 00:00:00 2001
From: Beatrycze Volk <beatrycze.volk@slub-dresden.de>
Date: Thu, 18 Apr 2024 17:07:20 +0200
Subject: [PATCH] Fix PHP docs for `ModsReader` class

---
 src/Mods/ModsReader.php | 60 +++++++++++++++++++++++++++--------------
 1 file changed, 40 insertions(+), 20 deletions(-)

diff --git a/src/Mods/ModsReader.php b/src/Mods/ModsReader.php
index e27d7c0..52e2bf7 100644
--- a/src/Mods/ModsReader.php
+++ b/src/Mods/ModsReader.php
@@ -36,6 +36,7 @@
 
 /**
  * Metadata MODS reader class for the 'php-mods-reader' library.
+ * @see https://www.loc.gov/standards/mods/userguide/generalapp.html
  *
  * @access public
  */
@@ -62,7 +63,8 @@ public function __construct(\SimpleXMLElement $xml)
     }
 
     /**
-     * Get 
+     * Get the value of the <abstract> element.
+     * @see https://www.loc.gov/standards/mods/userguide/abstract.html
      *
      * @access public
      *
@@ -81,7 +83,8 @@ public function getAbstract(string $query = ''): ?AbstractElement
     }
 
     /**
-     * Get 
+     * Get the the array of the <accessCondition> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/accesscondition.html
      *
      * @access public
      *
@@ -103,7 +106,8 @@ public function getAccessConditions(string $query = ''): array
     }
 
     /**
-     * Get 
+     * Get the the array of the <classification> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/classification.html
      *
      * @access public
      *
@@ -125,7 +129,8 @@ public function getClassifications(string $query = ''): array
     }
 
     /**
-     * Get 
+     * Get the the array of the <extension> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/extension.html
      *
      * @access public
      *
@@ -147,7 +152,8 @@ public function getExtensions(string $query = ''): array
     }
 
     /**
-     * Get 
+     * Get the the array of the <genre> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/genre.html
      *
      * @access public
      *
@@ -169,7 +175,8 @@ public function getGenres(string $query = ''): array
     }
 
     /**
-     * Get 
+     * Get the the array of the <identifier> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/identifier.html
      *
      * @access public
      *
@@ -214,7 +221,8 @@ public function getLanguages(string $query = ''): array
     }
 
     /**
-     * Get 
+     * Get the the array of the <location> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/location.html
      *
      * @access public
      *
@@ -236,7 +244,8 @@ public function getLocations(string $query = ''): array
     }
 
     /**
-     * Get 
+     * Get the the array of the <name> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/name.html
      *
      * @access public
      *
@@ -258,7 +267,8 @@ public function getNames(string $query = ''): array
     }
 
     /**
-     * Get 
+     * Get the the array of the <note> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/note.html
      *
      * @access public
      *
@@ -280,7 +290,8 @@ public function getNotes(string $query = ''): array
     }
 
      /**
-     * Get 
+     * Get the the array of the <originInfo> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/origininfo.html
      *
      * @access public
      *
@@ -302,7 +313,8 @@ public function getOriginInfos(string $query = ''): array
     }
 
     /**
-     * Get 
+     * Get the the array of the <part> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/part.html
      *
      * @access public
      *
@@ -324,7 +336,8 @@ public function getParts(string $query = ''): array
     }
 
     /**
-     * Get 
+     * Get the the array of the <physicalDescription> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/physicaldescription.html
      *
      * @access public
      *
@@ -346,10 +359,11 @@ public function getPhysicalDescriptions(string $query = ''): array
     }
 
     /**
-     * Get 
+     * Get the the array of the <recordInfo> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/recordinfo.html
      *
      * @access public
-     * 
+     *
      * @param string $query The XPath query for metadata search
      *
      * @return RecordInfo[]
@@ -368,7 +382,8 @@ public function getRecordInfos(string $query = ''): array
     }
 
     /**
-     * Get 
+     * Get the the array of the <relatedItem> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/relateditem.html
      *
      * @access public
      *
@@ -390,7 +405,8 @@ public function getRelatedItems(string $query = ''): array
     }
 
     /**
-     * Get 
+     * Get the the array of the <subject> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/subject.html
      *
      * @access public
      *
@@ -412,7 +428,8 @@ public function getSubjects(string $query = ''): array
     }
 
     /**
-     * Get 
+     * Get the the array of the <tableOfContents> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/tableofcontents.html
      *
      * @access public
      *
@@ -434,7 +451,8 @@ public function getTableOfContents(string $query = ''): array
     }
 
     /**
-     * Get 
+     * Get the the array of the <targetAudience> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/targetaudience.html
      *
      * @access public
      *
@@ -456,7 +474,8 @@ public function getTargetAudience(string $query = ''): array
     }
 
     /**
-     * Get title info
+     * Get the the array of the <titleInfo> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/titleinfo.html
      *
      * @access public
      *
@@ -478,7 +497,8 @@ public function getTitleInfos(string $query = ''): array
     }
 
     /**
-     * Get 
+     * Get the value of the <typeOfResource> element.
+     * @see https://www.loc.gov/standards/mods/userguide/typeofresource.html
      *
      * @access public
      *