From acab20fe24998b87afef6d18dd50826f311f8c57 Mon Sep 17 00:00:00 2001
From: Uwe Steinmann <steinm@debian.org>
Date: Sat, 12 Sep 2020 12:53:27 +0200
Subject: [PATCH] add documentation for Indexer()

---
 inc/inc.ClassFulltextService.php | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/inc/inc.ClassFulltextService.php b/inc/inc.ClassFulltextService.php
index 1298f59b8..f10c7939b 100644
--- a/inc/inc.ClassFulltextService.php
+++ b/inc/inc.ClassFulltextService.php
@@ -70,6 +70,14 @@ class SeedDMS_FulltextService {
 		return new $this->services[0]['IndexedDocument']($document->getDMS(), $document, $this->converters, $nocontent, $this->cmdtimeout);
 	}
 
+	/**
+	 * Returns an instance of the indexer
+	 *
+	 * The indexer provides access to fulltext index. It allows to add and
+	 * get documents.
+	 *
+	 * @return object instance of class specified in 'Indexer'
+	 */
 	public function Indexer($recreate=false) {
 		if($this->index)
 			return $this->index;