http://www.mediawiki.org/wiki/Special:Code/MediaWiki/69120
Revision: 69120
Author: jeroendedauw
Date: 2010-07-06 23:59:36 +0000 (Tue, 06 Jul 2010)
Log Message:
-----------
Added docs
Modified Paths:
--------------
trunk/extensions/SemanticMaps/GeoCoords/SM_GeoCoordsValue.php
trunk/extensions/SemanticMaps/SemanticMaps.php
Modified: trunk/extensions/SemanticMaps/GeoCoords/SM_GeoCoordsValue.php
===================================================================
--- trunk/extensions/SemanticMaps/GeoCoords/SM_GeoCoordsValue.php
2010-07-06 23:53:14 UTC (rev 69119)
+++ trunk/extensions/SemanticMaps/GeoCoords/SM_GeoCoordsValue.php
2010-07-06 23:59:36 UTC (rev 69120)
@@ -20,6 +20,8 @@
* @author Jeroen De Dauw
* @author Markus Krötzsch
*
+ * @since 0.6
+ *
* @ingroup SemanticMaps
*/
class SMGeoCoordsValue extends SMWDataValue {
@@ -30,7 +32,11 @@
/**
* Adds support for the geographical coordinate data type to Semantic
MediaWiki.
*
+ * @since 0.6
+ *
* TODO: i18n keys still need to be moved
+ *
+ * @return true
*/
public static function initGeoCoordsType() {
SMWDataValueFactory::registerDatatype( '_geo', __CLASS__,
'Geographic coordinate' );
@@ -40,7 +46,11 @@
/**
* Defines the signature for geographical fields needed for the
smw_coords table.
*
+ * @since 0.6
+ *
* @param array $fieldTypes The field types defined by SMW, passed by
reference.
+ *
+ * @return true
*/
public static function initGeoCoordsFieldTypes( array $fieldTypes ) {
global $smgUseSpatialExtensions;
@@ -56,6 +66,8 @@
/**
* Defines the layout for the smw_coords table which is used to store
value of the GeoCoords type.
*
+ * @since 0.6
+ *
* @param array $propertyTables The property tables defined by SMW,
passed by reference.
*/
public static function initGeoCoordsTable( array $propertyTables ) {
@@ -76,6 +88,8 @@
/**
* @see SMWDataValue::parseUserValue
+ *
+ * @since 0.6
*/
protected function parseUserValue( $value ) {
$this->parseUserValueOrQuery( $value );
@@ -85,6 +99,8 @@
* Overwrite SMWDataValue::getQueryDescription() to be able to process
* comparators between all values.
*
+ * @since 0.6
+ *
* @param string $value
*
* @return SMWDescription
@@ -95,6 +111,11 @@
/**
* Parses the value into the coordinates and any meta data provided,
such as distance.
+ *
+ * @since 0.6
+ *
+ * @param $value String
+ * @param $asQuery Boolean
*/
protected function parseUserValueOrQuery( $value, $asQuery = false ) {
$this->mWikivalue = $value;
@@ -152,6 +173,8 @@
/**
* @see SMWDataValue::parseDBkeys
+ *
+ * @since 0.6
*/
protected function parseDBkeys( $args ) {
global $smgUseSpatialExtensions, $smgQPCoodFormat,
$smgQPCoodDirectional;
@@ -176,6 +199,8 @@
/**
* @see SMWDataValue::getDBkeys
+ *
+ * @since 0.6
*/
public function getDBkeys() {
global $smgUseSpatialExtensions;
@@ -201,6 +226,8 @@
/**
* @see SMWDataValue::getSignature
+ *
+ * @since 0.6
*/
public function getSignature() {
global $smgUseSpatialExtensions;
@@ -209,6 +236,8 @@
/**
* @see SMWDataValue::getShortWikiText
+ *
+ * @since 0.6
*/
public function getShortWikiText( $linked = null ) {
if ( $this->isValid() && ( $linked !== null ) && ( $linked !==
false ) ) {
@@ -228,6 +257,8 @@
/**
* @see SMWDataValue::getShortHTMLText
+ *
+ * @since 0.6
*/
public function getShortHTMLText( $linker = null ) {
return $this->getShortWikiText( $linker );
@@ -235,6 +266,8 @@
/**
* @see SMWDataValue::getLongWikiText
+ *
+ * @since 0.6
*/
public function getLongWikiText( $linked = null ) {
if ( !$this->isValid() ) {
@@ -248,6 +281,8 @@
/**
* @see SMWDataValue::getLongHTMLText
+ *
+ * @since 0.6
*/
public function getLongHTMLText( $linker = null ) {
return $this->getLongWikiText( $linker );
@@ -255,6 +290,8 @@
/**
* @see SMWDataValue::getWikiValue
+ *
+ * @since 0.6
*/
public function getWikiValue() {
$this->unstub();
@@ -263,6 +300,8 @@
/**
* @see SMWDataValue::getExportData
+ *
+ * @since 0.6
*/
public function getExportData() {
if ( $this->isValid() ) {
@@ -287,6 +326,8 @@
* $3: The latitude in non-directional float notation.
* $4 The longitude in non-directional float notation.
*
+ * @since 0.6.4
+ *
* @return array
*/
protected function getServiceLinkParams() {
@@ -299,6 +340,8 @@
}
/**
+ * @since 0.6
+ *
* @return array
*/
public function getCoordinateSet() {
@@ -308,6 +351,8 @@
/**
* @see SMWDataValue::getValueIndex
*
+ * @since 0.6
+ *
* @return integer
*/
public function getValueIndex() {
@@ -317,6 +362,8 @@
/**
* @see SMWDataValue::getLabelIndex
*
+ * @since 0.6
+ *
* @return integer
*/
public function getLabelIndex() {
Modified: trunk/extensions/SemanticMaps/SemanticMaps.php
===================================================================
--- trunk/extensions/SemanticMaps/SemanticMaps.php 2010-07-06 23:53:14 UTC
(rev 69119)
+++ trunk/extensions/SemanticMaps/SemanticMaps.php 2010-07-06 23:59:36 UTC
(rev 69120)
@@ -61,6 +61,10 @@
* 'Initialization' function for the Semantic Maps extension.
* The only work done here is creating the extension credits for
* Semantic Maps. The actuall work in done via the Maps hooks.
+ *
+ * @since 0.1
+ *
+ * @return true
*/
function smfSetup() {
global $wgExtensionCredits, $wgLang, $wgOut, $egMapsServices,
$smgScriptPath;
@@ -94,6 +98,10 @@
/**
* Adds a link to Admin Links page.
+ *
+ * @since 0.2
+ *
+ * @return true
*/
function smfAddToAdminLinks( &$admin_links_tree ) {
$displaying_data_section = $admin_links_tree->getSection( wfMsg(
'smw_adminlinks_displayingdata' ) );
_______________________________________________
MediaWiki-CVS mailing list
MediaWiki-CVS@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
