Merge "Improve WikiMap::getWikiReferenceFromWgConf()"

[lhc/web/wiklou.git] / includes / SiteConfiguration.php

diff --git a/includes/SiteConfiguration.php b/includes/SiteConfiguration.php
index 5b9bdfa..9fd5983 100644 (file)
--- a/includes/SiteConfiguration.php
+++ b/includes/SiteConfiguration.php
@@ -108,6 +108,11 @@
  * extract( $globals );
  * @endcode
  *
+ * @note For WikiMap to function, the configuration must define string values for
+ *  $wgServer (or $wgCanonicalServer) and $wgArticlePath, even if these are the
+ *  same for all wikis or can be correctly determined by the logic in
+ *  Setup.php.
+ *
  * @todo Give examples for,
  * suffixes:
  * $conf->suffixes = array( 'wiki' );