http://www.mediawiki.org/wiki/Special:Code/MediaWiki/69122
Revision: 69122
Author: jeroendedauw
Date: 2010-07-07 00:18:37 +0000 (Wed, 07 Jul 2010)
Log Message:
-----------
Added docs
Modified Paths:
--------------
trunk/extensions/Maps/Services/Maps_MappingService.php
trunk/extensions/Maps/Services/OSM/Maps_OSM.php
trunk/extensions/Maps/Services/OSM/Maps_OSMDispMap.php
trunk/extensions/Maps/Services/OSM/OSM.php
Modified: trunk/extensions/Maps/Services/Maps_MappingService.php
===================================================================
--- trunk/extensions/Maps/Services/Maps_MappingService.php 2010-07-07
00:06:21 UTC (rev 69121)
+++ trunk/extensions/Maps/Services/Maps_MappingService.php 2010-07-07
00:18:37 UTC (rev 69122)
@@ -1,7 +1,7 @@
<?php
/**
- * This file holds the general information for the Google Maps service
+ * File holding the MapsMappingService class.
*
* @file Maps_MappingService.php
* @ingroup Maps
@@ -13,38 +13,57 @@
die( 'Not an entry point.' );
}
+/**
+ * Base class for mapping services. Deriving classes hold mapping service
specific
+ * information and functionality, which can be used by any mapping feature.
+ *
+ * @since 0.6.3
+ *
+ * @author Jeroen De Dauw
+ */
class MapsMappingService implements iMappingService {
/**
+ * The internal name of the service.
*
* @var string
*/
protected $mServiceName;
/**
+ * A list of aliases for the internal name.
*
* @var array
*/
protected $mAliases;
/**
+ * A list of features that support the service, used for validation and
defaulting.
*
* @var array
*/
protected $mFeatures;
/**
+ * A list of parameter info specific to the service, which can be used
by any feature
+ * to pass along to Validator to handle parameters.
*
* @var mixed Array or false
*/
private $mParameterInfo = false;
/**
+ * A list of dependencies (header items) that have been added.
*
* @var array
*/
private $mAddedDependencies = array();
+ /**
+ * A list of dependencies (header items) that need to be added.
+ *
+ * @var array
+ */
private $mDependencies = array();
/**
Modified: trunk/extensions/Maps/Services/OSM/Maps_OSM.php
===================================================================
--- trunk/extensions/Maps/Services/OSM/Maps_OSM.php 2010-07-07 00:06:21 UTC
(rev 69121)
+++ trunk/extensions/Maps/Services/OSM/Maps_OSM.php 2010-07-07 00:18:37 UTC
(rev 69122)
@@ -14,14 +14,22 @@
}
/**
- * TODO
+ * Class holding information and functionallity specific to OSM.
+ * This infomation and features can be used by any mapping feature.
*
+ * @since 0.6.4
+ *
* @ingroup OSM
*
* @author Jeroen De Dauw
*/
class MapsOSM extends MapsMappingService {
+ /**
+ * Constructor.
+ *
+ * @since 0.6.4
+ */
function __construct() {
parent::__construct(
'osm',
Modified: trunk/extensions/Maps/Services/OSM/Maps_OSMDispMap.php
===================================================================
--- trunk/extensions/Maps/Services/OSM/Maps_OSMDispMap.php 2010-07-07
00:06:21 UTC (rev 69121)
+++ trunk/extensions/Maps/Services/OSM/Maps_OSMDispMap.php 2010-07-07
00:18:37 UTC (rev 69122)
@@ -1,7 +1,7 @@
<?php
/**
- * Class for handling the display_map parser function with OSM
+ * File holding the MapsOSMDispMap class.
*
* @file Maps_OSMDispMap.php
* @ingroup OSM
@@ -13,8 +13,20 @@
die( 'Not an entry point.' );
}
+/**
+ * Class for handling the display_map parser function with OSM.
+ *
+ * @since 0.6.4
+ *
+ * @ingroup OSM
+ *
+ * @author Jeroen De Dauw
+ */
class MapsOSMDispMap extends MapsBaseMap {
+ /**
+ * @since 0.6.4
+ */
protected function getDefaultZoom() {
global $egMapsOSMZoom;
return $egMapsOSMZoom;
@@ -22,6 +34,8 @@
/**
* @see MapsBaseMap::addSpecificMapHTML()
+ *
+ * @since 0.6.4
*/
public function addSpecificMapHTML() {
global $egMapsOSMPrefix, $egOSMOnThisPage;
Modified: trunk/extensions/Maps/Services/OSM/OSM.php
===================================================================
--- trunk/extensions/Maps/Services/OSM/OSM.php 2010-07-07 00:06:21 UTC (rev
69121)
+++ trunk/extensions/Maps/Services/OSM/OSM.php 2010-07-07 00:18:37 UTC (rev
69122)
@@ -22,6 +22,13 @@
$wgHooks['MappingServiceLoad'][] = 'efMapsInitOSM';
+/**
+ * Initialization function for the OSM service.
+ *
+ * @since 0.6.4
+ *
+ * @return true
+ */
function efMapsInitOSM() {
global $egMapsServices, $wgAutoloadClasses;
_______________________________________________
MediaWiki-CVS mailing list
MediaWiki-CVS@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
