Document namespaces member as nullable
authorErik Bernhardson <ebernhardson@wikimedia.org>
Mon, 4 May 2015 22:03:15 +0000 (15:03 -0700)
committerErik Bernhardson <ebernhardson@wikimedia.org>
Tue, 5 May 2015 18:11:32 +0000 (11:11 -0700)
This variable is set to null in the replacePrefixes method, document
it as such to prevent errors in consuming code.

Bug: T98082
Change-Id: I78880ffe590ed7193b8482c0ae41c8c69e495878

includes/search/SearchEngine.php

index 5770276..e5ed23f 100644 (file)
@@ -33,7 +33,7 @@ class SearchEngine {
        /** @var string */
        public $prefix = '';
 
-       /** @var int[] */
+       /** @var int[]|null */
        public $namespaces = array( NS_MAIN );
 
        /** @var int */
@@ -293,7 +293,7 @@ class SearchEngine {
         * Set which namespaces the search should include.
         * Give an array of namespace index numbers.
         *
-        * @param array $namespaces
+        * @param int[]|null $namespaces
         */
        function setNamespaces( $namespaces ) {
                $this->namespaces = $namespaces;