From 6ee86c50a6896cb9d51298660eb45c88068a2f96 Mon Sep 17 00:00:00 2001 From: Happy-melon Date: Sat, 23 Apr 2011 14:16:12 +0000 Subject: [PATCH] Document SpecialPageFactory::getAliasList() --- includes/SpecialPageFactory.php | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/includes/SpecialPageFactory.php b/includes/SpecialPageFactory.php index 21590f177e..b12be2666d 100644 --- a/includes/SpecialPageFactory.php +++ b/includes/SpecialPageFactory.php @@ -192,7 +192,12 @@ class SpecialPageFactory { } /** - * @return array + * Initialise and return the list of special page aliases. Returns an object with + * properties which can be accessed $obj->pagename - each property is an array of + * aliases; the first in the array is the cannonical alias. All registered special + * pages are guaranteed to have a property entry, and for that property array to + * contain at least one entry (English fallbacks will be added if necessary). + * @return Object */ static function getAliasList() { if ( !is_object( self::$mAliases ) ) { -- 2.20.1