Merge "Type hint against LinkTarget in WatchedItemStore"

[lhc/web/wiklou.git] / includes / site / MediaWikiSite.php

diff --git a/includes/site/MediaWikiSite.php b/includes/site/MediaWikiSite.php
index 0ff7e8b..14c9a73 100644 (file)
--- a/includes/site/MediaWikiSite.php
+++ b/includes/site/MediaWikiSite.php
@@ -22,7 +22,7 @@ use MediaWiki\Site\MediaWikiPageNameNormalizer;
  *
  * @file
  * @ingroup Site
- * @license GNU GPL v2+
+ * @license GPL-2.0-or-later
  * @author John Erling Blad < jeblad@gmail.com >
  * @author Daniel Kinzler
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
@@ -65,6 +65,7 @@ class MediaWikiSite extends Site {
         * Returns the normalized form of the given page title, using the
         * normalization rules of the given site. If the given title is a redirect,
         * the redirect will be resolved and the redirect target is returned.
+        * Only titles of existing pages will be returned.
         *
         * @note This actually makes an API request to the remote site, so beware
         *   that this function is slow and depends on an external service.
@@ -79,7 +80,9 @@ class MediaWikiSite extends Site {
         *
         * @param string $pageName
         *
-        * @return string|false
+        * @return string|false The normalized form of the title,
+        * or false to indicate an invalid title, a missing page,
+        * or some other kind of error.
         * @throws MWException
         */
        public function normalizePageName( $pageName ) {