wikimedia / mediawiki

includes/search/SearchEngine.php

Doc Comments +7 added lines, -6 removed lines

@@ -104,7 +104,7 @@ 
 	 * @since 1.18
 	 * @param string $feature
 	 * @param mixed $data
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function setFeatureData( $feature, $data ) {
 		$this->features[$feature] = $data;
@@ -301,7 +301,7 @@ 
 
 	/**
 	 * Find snippet highlight settings for all users
-	 * @return array Contextlines, contextchars
+	 * @return integer[] Contextlines, contextchars
 	 */
 	public static function userHighlightPrefs() {
 		$contextlines = 2; // Hardcode this. Old defaults sucked. :)
@@ -507,6 +507,7 @@ 
 	 * Process completion search results.
 	 * Resolves the titles and rescores.
 	 * @param SearchSuggestionSet $suggestions
+	 * @param string $search
 	 * @return SearchSuggestionSet
 	 */
 	protected function processCompletionResults( $search, SearchSuggestionSet $suggestions ) {
@@ -590,7 +591,7 @@ 
 	 * settings, returning a list of index numbers.
 	 * @deprecated since 1.27; use SearchEngineConfig::userNamespaces()
 	 * @param user $user
-	 * @return array
+	 * @return integer[]
 	 */
 	public static function userNamespaces( $user ) {
 		return MediaWikiServices::getInstance()->getSearchEngineConfig()->userNamespaces( $user );
@@ -599,7 +600,7 @@ 
 	/**
 	 * An array of namespaces indexes to be searched by default
 	 * @deprecated since 1.27; use SearchEngineConfig::defaultNamespaces()
-	 * @return array
+	 * @return integer[]
 	 */
 	public static function defaultNamespaces() {
 		return MediaWikiServices::getInstance()->getSearchEngineConfig()->defaultNamespaces();
@@ -610,7 +611,7 @@ 
 	 * and preferences
 	 * @deprecated since 1.27; use SearchEngineConfig::namespacesAsText()
 	 * @param array $namespaces
-	 * @return array
+	 * @return string[]
 	 */
 	public static function namespacesAsText( $namespaces ) {
 		return MediaWikiServices::getInstance()->getSearchEngineConfig()->namespacesAsText( $namespaces );
@@ -648,7 +649,7 @@ 
 	 * - default: set to true if this profile is the default
 	 *
 	 * @since 1.28
-	 * @param $profileType the type of profiles
+	 * @param string $profileType the type of profiles
 	 * @return array|null the list of profiles or null if none available
 	 */
 	public function getProfiles( $profileType ) {