diff --git a/inc/inc.ClassFulltextService.php b/inc/inc.ClassFulltextService.php index 142943183..23309cf6c 100644 --- a/inc/inc.ClassFulltextService.php +++ b/inc/inc.ClassFulltextService.php @@ -7,17 +7,27 @@ * @license GPL 2 * @version @version@ * @author Uwe Steinmann - * @copyright Copyright (C) 2016 Uwe Steinmann + * @copyright Copyright (C) 2021-2023 Uwe Steinmann * @version Release: @package_version@ */ /** * Implementation of fulltext service * + * The fulltext service is wrapper around single services for a full text + * search. Such a service can be based on Solr, SQlite, etc. It implements + * three major methods: + * IndexedDocument() for creating an instance of an indexed document + * Indexer() for creating an instance of the index + * Search() fro creating an instance of a search frontend + * + * Though this class can manage more than one service, it will only + * use the first one. + * * @category DMS * @package SeedDMS * @author Uwe Steinmann - * @copyright Copyright (C) 2016 Uwe Steinmann + * @copyright Copyright (C) 2021-2023 Uwe Steinmann * @version Release: @package_version@ */ class SeedDMS_FulltextService { @@ -136,7 +146,7 @@ class SeedDMS_FulltextService { /** * Returns callback function to convert a document into plain text * - * This variant just uses the text previewer which + * This variant uses the text previewer which * caches the converted document */ public function getConversionWithPreviewCallback() { /* {{{ */ @@ -162,7 +172,7 @@ class SeedDMS_FulltextService { } /* }}} */ /** - * Return an indexable document from the given document or folder + * Return an indexable document based on the given document or folder * * @param SeedDMS_Core_Document|SeedDMS_Core_Folder $object document or folder * to be indexed @@ -183,7 +193,7 @@ class SeedDMS_FulltextService { /** * Returns an instance of the indexer * - * The indexer provides access to fulltext index. It allows to add and + * The indexer provides access to the fulltext index. It allows to add and * get documents. * * @return object instance of class specified in 'Indexer'