Add comments for private methods in ResultDocument

Classes/Common/SolrSearchResult/ResultDocument.php

@@ -207,12 +207,28 @@ public function getHighlightsIds() {
         return $highlightsIds;
     }
 
+    /**
+     * Parse snippets array to string for displaying purpose.
+     * Snippets are stored in 'text' field of 'snippets' object.
+     *
+     * @access private
+     *
+     * @return void
+     */
     private function parseSnippets() {
         $snippetArray = $this->getArrayByIndex('text');
 
         $this->snippets = !empty($snippetArray) ? implode(' [...] ', $snippetArray) : '';
     }
 
+    /**
+     * Parse pages array to array of Page objects.
+     * Pages are stored in 'pages' field of 'snippets' object.
+     *
+     * @access private
+     *
+     * @return void
+     */
     private function parsePages() {
         $pageArray = $this->getArrayByIndex('pages');
 
@@ -225,6 +241,14 @@ private function parsePages() {
         }
     }
 
+    /**
+     * Parse regions array to array of Region objects.
+     * Regions are stored in 'regions' field of 'snippets' object.
+     *
+     * @access private
+     *
+     * @return void
+     */
     private function parseRegions() {
         $regionArray = $this->getArrayByIndex('regions');
 
@@ -237,6 +261,14 @@ private function parseRegions() {
         }
     }
 
+    /**
+     * Parse highlights array to array of Highlight objects.
+     * Highlights are stored in 'highlights' field of 'snippets' object.
+     *
+     * @access private
+     *
+     * @return void
+     */
     private function parseHighlights() {
         $highlightArray = $this->getArrayByIndex('highlights');
 
@@ -249,6 +281,15 @@ private function parseHighlights() {
         }
     }
 
+    /**
+     * Get array for given index.
+     *
+     * @access private
+     *
+     * @param string $index: Name of field for which array is going be created
+     *
+     * @return array
+     */
     private function getArrayByIndex($index) {
         $objectArray = [];
         foreach ($this->snippetsForRecord as $snippet) {