Enalean / tuleap

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/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();
 

plugins/fulltextsearch/include/FullTextSearchWikiActions.class.php

Doc Comments +10 added lines

@@ -44,6 +44,10 @@ 
         $this->logger               = $logger;
     }
 
+    /**
+     * @param integer $project_id
+     * @param integer $wiki_page_id
+     */
     private function indexOrUpdate($project_id, $wiki_page_id, $data) {
         try {
             $this->client->getIndexedElement($project_id, $wiki_page_id);
@@ -113,6 +117,9 @@ 
         }
     }
 
+    /**
+     * @param integer $project_id
+     */
     private function deleteForProject($project_id) {
         $this->logger->debug('[Wiki] ElasticSearch: deleting all project wiki pages #' . $project_id);
 
@@ -143,6 +150,9 @@ 
         $this->indexOrUpdate($wiki_page->getGid(), $wiki_page->getId(), $update_data);
     }
 
+    /**
+     * @param integer $project_id
+     */
     private function indexAllProjectWikiPages($project_id) {
         $indexable_pages = $this->getAllIndexablePagesForProject($project_id);
 

plugins/fulltextsearch/include/SystemEvent_FULLTEXTSEARCH_DOCMAN.class.php

Doc Comments +6 added lines

@@ -98,6 +98,7 @@ 
     }
 
     /**
+     * @param integer $version_number
      * @return Docman_Version
      */
     protected function getVersion(Docman_Item $item, $version_number) {
@@ -120,6 +121,11 @@ 
         return $txt;
     }
 
+    /**
+     * @param integer $group_id
+     * @param integer $item_id
+     * @param boolean $with_link
+     */
     private function verbalizeDocmanItemId($group_id, $item_id, $with_link) {
         $txt = '#'. $item_id;
         if ($with_link) {

plugins/fulltextsearch/include/SystemEvent_FULLTEXTSEARCH_DOCMAN_UPDATELINK.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -33,7 +33,8 @@
     }
 
     /**
-     * @return Docman_Version
+     * @param integer $version_number
+     * @return null|Docman_LinkVersion
      */
     private function getLinkVersion(Docman_Link $item, $version_number) {
         return $this->link_version_factory->getSpecificVersion($item, $version_number);

plugins/fulltextsearch/include/SystemEvent_FULLTEXTSEARCH_WIKI.class.php

Doc Comments +10 added lines

@@ -55,6 +55,10 @@ 
         return false;
     }
 
+    /**
+     * @param integer $group_id
+     * @param string $wiki_page_name
+     */
     protected function getWikiPage($group_id, $wiki_page_name) {
         return new WikiPage($group_id, $wiki_page_name);
     }
@@ -65,6 +69,7 @@ 
      * @see process()
      *
      * @param WikiPage $wiki_page The wiki page
+     * @param integer $group_id
      *
      * @return bool true if success (means status=done), false otherwise
      */
@@ -82,6 +87,11 @@ 
         return $txt;
     }
 
+    /**
+     * @param integer $group_id
+     * @param string $wiki_page_name
+     * @param boolean $with_link
+     */
     private function verbalizeWikiPageId($group_id, $wiki_page_name, $with_link) {
         if ($with_link) {
             $txt = '<a href="/wiki/index.php?group_id='. $group_id .'&pagename='. $wiki_page_name.'">'. $wiki_page_name .'</a>';

plugins/fulltextsearch/tests/builders/Docman_File_Builder.php

Doc Comments +15 added lines

@@ -45,26 +45,41 @@
         return $docman_file;
     }
     
+    /**
+     * @param integer $item_id
+     */
     public function withId($item_id) {
         $this->item_id = $item_id;
         return $this;
     }
     
+    /**
+     * @param integer $group_id
+     */
     public function withGroupId($group_id) {
         $this->group_id = $group_id;
         return $this;
     }
     
+    /**
+     * @param integer $owner_id
+     */
     public function withOwnerId($owner_id) {
         $this->owner_id = $owner_id;
         return $this;
     }
 
+    /**
+     * @param string $title
+     */
     public function withTitle($title) {
         $this->title = $title;
         return $this;
     }
     
+    /**
+     * @param string $description
+     */
     public function withDescription($description) {
         $this->description = $description;
         return $this;