Thiemo Mättig (WMDE) has uploaded a new change for review.
https://gerrit.wikimedia.org/r/257839
Change subject: Fix broken and incomplete PHPDoc comments
......................................................................
Fix broken and incomplete PHPDoc comments
Change-Id: I4f85b2dee1208932fa1e6d7a420ae6c91de5258a
---
M includes/BuildDocument/SuggestBuilder.php
M includes/BuildDocument/SuggestScoring.php
M includes/NearMatchPicker.php
M includes/Search/RescoreBuilders.php
M includes/Search/Result.php
M includes/Search/ResultsType.php
M includes/Search/SearchContext.php
M includes/SearchConfig.php
M includes/Searcher.php
M tests/jenkins/Jenkins.php
10 files changed, 14 insertions(+), 13 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/CirrusSearch
refs/changes/39/257839/1
diff --git a/includes/BuildDocument/SuggestBuilder.php
b/includes/BuildDocument/SuggestBuilder.php
index 45824f9..0ec199c 100644
--- a/includes/BuildDocument/SuggestBuilder.php
+++ b/includes/BuildDocument/SuggestBuilder.php
@@ -144,7 +144,7 @@
* to make this decision at index time.
*
* @param int $id the page id
- * @param array of string $redirects the redirects
+ * @param string[] $redirects
* @param array $location the geo coordinates or null if unavailable
* @param int $score the weight of the suggestion
* @return array the suggestion document
diff --git a/includes/BuildDocument/SuggestScoring.php
b/includes/BuildDocument/SuggestScoring.php
index 6d9477b..7cd1abc 100644
--- a/includes/BuildDocument/SuggestScoring.php
+++ b/includes/BuildDocument/SuggestScoring.php
@@ -123,7 +123,7 @@
/**
* @param integer $maxDocs the number of docs in the index
- * @param array of key values, key is the template name, value the
boost factor.
+ * @param float[]|null $boostTemplates Array of key values, key is the
template name, value the boost factor.
* Defaults to Util::getDefaultBoostTemplates()
*/
public function __construct( $maxDocs, $boostTemplates = null ) {
diff --git a/includes/NearMatchPicker.php b/includes/NearMatchPicker.php
index 556ced8..ba0d88e 100644
--- a/includes/NearMatchPicker.php
+++ b/includes/NearMatchPicker.php
@@ -31,7 +31,7 @@
*/
private $term;
/**
- * @var array(Title) potential near matches
+ * @var array[] Potential near matches
*/
private $titles;
@@ -40,7 +40,7 @@
*
* @param Language $language to use during normalization process
* @param string $term the search term
- * @param array with optional keys:
+ * @param array[] $titles Array of arrays, each with optional keys:
* titleMatch => a title if the title matched
* redirectMatches => an array of redirect matches, one per matched
redirect
*/
diff --git a/includes/Search/RescoreBuilders.php
b/includes/Search/RescoreBuilders.php
index 211be93..08a0c3a 100644
--- a/includes/Search/RescoreBuilders.php
+++ b/includes/Search/RescoreBuilders.php
@@ -254,7 +254,7 @@
abstract class FunctionScoreBuilder {
/**
- * @param SearchContext the search context
+ * @param SearchContext $context
*/
protected $context;
public function __construct( SearchContext $context ) {
@@ -277,7 +277,7 @@
private $boostTemplates;
/**
- * @param SearchContext the search context
+ * @param SearchContext $context
*/
public function __construct( SearchContext $context ) {
parent::__construct( $context );
@@ -321,7 +321,7 @@
/**
- * @param SearchContext the search context
+ * @param SearchContext $context
*/
public function __construct( SearchContext $context ) {
parent::__construct( $context );
diff --git a/includes/Search/Result.php b/includes/Search/Result.php
index 2cb6fd1..99be681 100644
--- a/includes/Search/Result.php
+++ b/includes/Search/Result.php
@@ -169,7 +169,7 @@
/**
* Build the redirect title from the highlighted redirect snippet.
- * @param string highlighted redirect snippet
+ * @param string $snippet Highlighted redirect snippet
* @param array $redirects Array of redirects stored as arrays with
'title' and 'namespace' keys
* @return Title object representing the redirect
*/
diff --git a/includes/Search/ResultsType.php b/includes/Search/ResultsType.php
index beb85f9..2f96694 100644
--- a/includes/Search/ResultsType.php
+++ b/includes/Search/ResultsType.php
@@ -135,7 +135,7 @@
/**
* Convert the results to titles.
- * @return array with optional keys:
+ * @return array[] Array of arrays, each with optional keys:
* titleMatch => a title if the title matched
* redirectMatches => an array of redirect matches, one per matched
redirect
*/
diff --git a/includes/Search/SearchContext.php
b/includes/Search/SearchContext.php
index e67b321..4da4ea0 100644
--- a/includes/Search/SearchContext.php
+++ b/includes/Search/SearchContext.php
@@ -202,7 +202,7 @@
/**
* @deprecated use rescore profiles
- * @param boolean deactivate IncomingLinksFunctionScoreBuilder if
present in the rescore profile
+ * @param boolean $boostLinks Deactivate
IncomingLinksFunctionScoreBuilder if present in the rescore profile
*/
public function setBoostLinks( $boostLinks ) {
$this->boostLinks = $boostLinks;
diff --git a/includes/SearchConfig.php b/includes/SearchConfig.php
index 568d2e3..a3cad3b 100644
--- a/includes/SearchConfig.php
+++ b/includes/SearchConfig.php
@@ -141,7 +141,7 @@
/**
* For Unit tests
- * @param Config override source
+ * @param array $source Config override source
*/
protected function setSource( $source ) {
$this->source = $source;
diff --git a/includes/Searcher.php b/includes/Searcher.php
index 26d76a6..455c4ae 100644
--- a/includes/Searcher.php
+++ b/includes/Searcher.php
@@ -196,9 +196,10 @@
/**
* Constructor
+ * @param Connection $conn
* @param int $offset Offset the results by this much
* @param int $limit Limit the results to this many
- * @param SearchConfig Configuration settings
+ * @param SearchConfig|null $config Configuration settings
* @param int[]|null $namespaces Array of namespace numbers to search
or null to search all namespaces.
* @param User|null $user user for which this search is being
performed. Attached to slow request logs.
* @param string|boolean $index Base name for index to search from,
defaults to wfWikiId()
diff --git a/tests/jenkins/Jenkins.php b/tests/jenkins/Jenkins.php
index c208605..62c6a63 100644
--- a/tests/jenkins/Jenkins.php
+++ b/tests/jenkins/Jenkins.php
@@ -92,7 +92,7 @@
/**
* If the page ends in '/<language code>' then set the page's language
to that code.
- * @param Title @title page title object
+ * @param Title $title page title object
* @param string|Language $pageLang the page content language (either
an object or a language code)
* @param Language $wgLang the user language
*/
--
To view, visit https://gerrit.wikimedia.org/r/257839
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I4f85b2dee1208932fa1e6d7a420ae6c91de5258a
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/CirrusSearch
Gerrit-Branch: master
Gerrit-Owner: Thiemo Mättig (WMDE) <thiemo.maet...@wikimedia.de>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
