Enalean / tuleap

plugins/fulltextsearch/include/ElasticSearch/RequestDocmanDataFactory.class.php

Doc Comments -1 removed lines

@@ -180,7 +180,6 @@
      * Builds the indexed data for first indexation
      *
      * @param Docman_Item    $item
-     * @param Docman_Version $version
      *
      * @return array
      */

plugins/fulltextsearch/include/ElasticSearch/SearchClientFacade.class.php

Doc Comments +4 added lines

@@ -77,6 +77,7 @@ 
     }
 
     /**
+     * @param string $terms
      * @return array to be used for querying ES
      */
     protected function getSearchInFieldsQuery($terms, $fields, $offset) {
@@ -161,6 +162,9 @@ 
         return $query;
     }
 
+    /**
+     * @param string[] $returned_fields
+     */
     private function addFieldsForDocman(&$returned_fields) {
         $returned_fields[] = 'title';
     }

plugins/fulltextsearch/include/FullTextSearch/DocmanSystemEventManager.class.php

Doc Comments +3 added lines

@@ -273,6 +273,9 @@
         );
     }
 
+    /**
+     * @param integer $project_id
+     */
     public function isProjectReindexationAlreadyQueued($project_id) {
         return $this->system_event_manager->areThereMultipleEventsQueuedMatchingFirstParameter(SystemEvent_FULLTEXTSEARCH_DOCMAN_REINDEX_PROJECT::NAME, $project_id);
     }

plugins/fulltextsearch/include/FullTextSearch/IIndexDocuments.class.php

Doc Comments -1 removed lines

@@ -43,7 +43,6 @@
      *
      * @param string $type
      * @param string $document_id
-     * @param array  $options Parameters to pass to delete action
      * 
      * @return array
      */

plugins/fulltextsearch/include/FullTextSearch/ISearchDocuments.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
     /**
      * Search for data in the index, filter them with permissions
      * 
-     * @param String $term   terms
+     * @param String $terms   terms
      * @param array  $facets submitted by user for faceted navigation
      * @param int    $offset The offset of the search
      * @param PFUser   $user   The user which do the request

plugins/fulltextsearch/include/FullTextSearch/TrackerSystemEventManager.class.php

Doc Comments +3 added lines

@@ -152,6 +152,9 @@
         }
     }
 
+    /**
+     * @param integer $project_id
+     */
     public function isProjectReindexationAlreadyQueued($project_id) {
         return $this->system_event_manager->areThereMultipleEventsQueuedMatchingFirstParameter(SystemEvent_FULLTEXTSEARCH_TRACKER_REINDEX_PROJECT::NAME, $project_id);
     }

plugins/fulltextsearch/include/FullTextSearchDocmanActions.class.php

Doc Comments +4 added lines, -3 removed lines

@@ -182,7 +182,6 @@ 
      * Update document approval comments
      *
      * @param Docman_Item $item
-     * @param Docman_Version $version
      */
     public function indexDocumentApprovalComment(Docman_Item $item) {
         $this->logger->debug('index new document approval comment #' . $item->getId());
@@ -227,7 +226,7 @@ 
      * Index a new document with permissions
      *
      * @param Docman_Item    $item    The docman item
-     * @param Docman_Version $version The version to index
+     * @param Docman_LinkVersion $version The version to index
      */
     public function indexNewLinkVersion(Docman_Item $item, Docman_LinkVersion $version) {
         try {
@@ -245,7 +244,6 @@ 
      * Index a new wiki document with permissions
      *
      * @param Docman_Item    $item               The docman item
-     * @param Docman_Version $version            The version to index
      * @param array          $wiki_page_metadata WikiPage metadata
      */
     public function indexNewWikiVersion(Docman_Item $item, array $wiki_page_metadata) {
@@ -411,6 +409,9 @@ 
 
     }
 
+    /**
+     * @param integer $project_id
+     */
     public function reIndexProjectDocuments(
         Docman_ProjectItemsBatchIterator $document_iterator,
         $project_id,

plugins/fulltextsearch/include/FulltextsearchPluginInfo.class.php

Doc Comments +3 added lines

@@ -24,6 +24,9 @@
 
 class FulltextsearchPluginInfo extends PluginFileInfo {
     
+    /**
+     * @param fulltextsearchPlugin $plugin
+     */
     public function __construct($plugin) {
         parent::__construct($plugin, 'fulltextsearch');
         $this->setPluginDescriptor(new FulltextsearchPluginDescriptor());

plugins/fulltextsearch/include/FullTextSearchTrackerActions.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -43,7 +43,7 @@ 
      *
      * @param FullTextSearch_IIndexDocuments $client Search client
      *
-     * @return Void
+     * @return FullTextSearchTrackerActions
      */
     public function __construct(FullTextSearch_IIndexDocuments $client, ElasticSearch_1_2_RequestTrackerDataFactory $tracker_data_factory, Logger $logger) {
         $this->client               = $client;
@@ -77,6 +77,9 @@ 
         $this->indexAllArtifacts($tracker);
     }
 
+    /**
+     * @param Tracker $tracker
+     */
     private function deleteTracker($tracker) {
         $tracker_id = $tracker->getId();