SemanticMediaWiki / SemanticMediaWiki

includes/datavalues/SMW_DV_Time.php

Doc Comments +13 added lines, -7 removed lines

@@ -186,14 +186,17 @@ 
 	 * The function sets the provided call-by-ref values to the respective
 	 * values. If errors are encountered, they are added to the objects
 	 * error list and false is returned. Otherwise, true is returned.
-	 * @param $string string input time representation, e.g. "12 May 2007 13:45:23-3:30"
+	 * @param string $string string input time representation, e.g. "12 May 2007 13:45:23-3:30"
 	 * @param $datecomponents array of strings that might belong to the specification of a date
 	 * @param $calendarmodesl string if model was set in input, otherwise false
-	 * @param $era string '+' or '-' if provided, otherwise false
-	 * @param $hours integer set to a value between 0 and 24
-	 * @param $minutes integer set to a value between 0 and 59
-	 * @param $seconds integer set to a value between 0 and 59, or false if not given
-	 * @param $timeoffset double set to a value for time offset (e.g. 3.5), or false if not given
+	 * @param boolean $era string '+' or '-' if provided, otherwise false
+	 * @param boolean $hours integer set to a value between 0 and 24
+	 * @param boolean $minutes integer set to a value between 0 and 59
+	 * @param boolean $seconds integer set to a value between 0 and 59, or false if not given
+	 * @param boolean $timeoffset double set to a value for time offset (e.g. 3.5), or false if not given
+	 * @param boolean $calendarmodel
+	 * @param boolean $microseconds
+	 * @param boolean $timezone
 	 * @return boolean stating if the parsing succeeded
 	 * @todo This method in principle allows date parsing to be internationalized further. Should be done.
 	 */
@@ -405,7 +408,7 @@ 
 	 * messages are added to the objects list of errors, and false is
 	 * returned. Otherwise, true is returned.
 	 * @param $datecomponents array of strings that might belong to the specification of a date
-	 * @param $date array set to result
+	 * @param boolean $date array set to result
 	 * @return boolean stating if successful
 	 */
 	protected function interpretDateComponents( $datecomponents, &$date ) {
@@ -788,6 +791,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $value
+	 */
 	private function isInterpretableAsYearOnly( $value ) {
 		return strpos( $value, ' ' ) === false && is_numeric( strval( $value ) ) && ( strval( $value ) < 0 || strlen( $value ) < 6 );
 	}

includes/dataitems/SMW_DI_Time.php

Doc Comments +2 added lines, -2 removed lines

@@ -285,7 +285,7 @@ 
 	 *
 	 * @param DateTime $dateTime
 	 *
-	 * @return SMWDITime|false
+	 * @return SMWDITime
 	 */
 	public static function newFromDateTime( DateTime $dateTime ) {
 
@@ -340,7 +340,7 @@ 
 	 *
 	 * @param string $timestamp must be in format
 	 *
-	 * @return SMWDITime|false
+	 * @return SMWDataItem
 	 */
 	public static function newFromTimestamp( $timestamp ) {
 		$timestamp = wfTimestamp( TS_MW, (string)$timestamp );

src/JulianDay.php

Doc Comments +10 added lines, -10 removed lines

@@ -37,7 +37,7 @@ 
 	 * calendar model, presicion.
 	 *
 	 * @param double $jdValue
-	 * @param integer|null $calendarmodel
+	 * @param integer|null $calendarModel
 	 * @param integer|null $precision
 	 *
 	 * @return DITime object
@@ -113,10 +113,10 @@ 
 	 * calendar model. This calculation assumes that neither calendar
 	 * has a year 0.
 	 *
-	 * @param $year integer representing the year
-	 * @param $month integer representing the month
-	 * @param $day integer representing the day
-	 * @param $calendarmodel integer either SMWDITime::CM_GREGORIAN or SMWDITime::CM_JULIAN
+	 * @param integer $year integer representing the year
+	 * @param integer $month integer representing the month
+	 * @param integer $day integer representing the day
+	 * @param integer $calendarmodel integer either SMWDITime::CM_GREGORIAN or SMWDITime::CM_JULIAN
 	 *
 	 * @return float Julian Day number
 	 * @throws RuntimeException
@@ -142,9 +142,9 @@ 
 	 * Compute the offset for the Julian Day number from a given time.
 	 * This computation is the same for all calendar models.
 	 *
-	 * @param $hours integer representing the hour
-	 * @param $minutes integer representing the minutes
-	 * @param $seconds integer representing the seconds
+	 * @param integer $hours integer representing the hour
+	 * @param integer $minutes integer representing the minutes
+	 * @param integer $seconds integer representing the seconds
 	 *
 	 * @return float offset for a Julian Day number to get this time
 	 */
@@ -159,7 +159,7 @@ 
 	 * conversion to Gregorian needs positive JD. If this happens, wrong
 	 * values will be returned. Avoid date conversions before 10000 BCE.
 	 *
-	 * @param $jdvalue float number of Julian Days
+	 * @param double $jdvalue float number of Julian Days
 	 * @param $calendarmodel integer either SMWDITime::CM_GREGORIAN or SMWDITime::CM_JULIAN
 	 *
 	 * @return array( yearnumber, monthnumber, daynumber )
@@ -207,7 +207,7 @@ 
 	 * Extract the time from a Julian Day number and return it as a string.
 	 * This conversion is the same for all calendar models.
 	 *
-	 * @param $jdvalue float number of Julian Days
+	 * @param double $jdvalue float number of Julian Days
 	 * @return array( hours, minutes, seconds )
 	 */
 	protected static function JD2Time( $jdvalue ) {

includes/datavalues/SMW_DataValue.php

Doc Comments +9 added lines, -8 removed lines

@@ -176,7 +176,7 @@ 
 	 * The third argument was added in SMW 1.9 and should not be used from outside SMW.
 	 *
 	 * @param string $value
-	 * @param mixed $caption
+	 * @param boolean $caption
 	 * @param boolean $approximateValue
 	 */
 	public function setUserValue( $value, $caption = false, $approximateValue = false ) {
@@ -258,7 +258,7 @@ 
 	 *
 	 * @since 1.8
 	 *
-	 * @return SMWDIProperty|null
+	 * @return SMWDIProperty
 	 */
 	public function getProperty() {
 		return $this->m_property;
@@ -280,7 +280,7 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @return DIWikiPage|null
+	 * @return SMWDIWikiPage
 	 */
 	public function getContextPage() {
 		return $this->m_contextPage;
@@ -300,7 +300,7 @@ 
 	 *
 	 * @param string $key
 	 *
-	 * @return mixed|false
+	 * @return string|false
 	 */
 	public function getOptionValueFor( $key ) {
 
@@ -324,7 +324,6 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @param string $caption
 	 */
 	public function getCaption() {
 		return $this->m_caption;
@@ -492,7 +491,7 @@ 
 	 *
 	 * @param string $value
 	 *
-	 * @return Description
+	 * @return SMW\Query\Language\Description
 	 * @throws InvalidArgumentException
 	 */
 	public function getQueryDescription( $value ) {
@@ -513,7 +512,7 @@ 
 	 *
 	 * @since 2.4
 	 *
-	 * @return DataValueFormatter
+	 * @return SMW\DataValues\ValueFormatters\DataValueFormatter
 	 */
 	public function getDataValueFormatter() {
 		return ValueFormatterRegistry::getInstance()->getDataValueFormatterFor( $this );
@@ -522,7 +521,7 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @return PropertySpecificationLookup
+	 * @return SMW\PropertySpecificationLookup
 	 */
 	public function getPropertySpecificationLookup() {
 		return ApplicationFactory::getInstance()->getPropertySpecificationLookup();
@@ -596,6 +595,7 @@ 
 	 *
 	 * The parameter $linker controls linking of values such as titles and should
 	 * be some Linker object (or NULL for no linking).
+	 * @return string
 	 */
 	abstract public function getShortHTMLText( $linker = null );
 
@@ -606,6 +606,7 @@ 
 	 *
 	 * The parameter $linked controls linking of values such as titles and should
 	 * be non-NULL and non-false if this is desired.
+	 * @return string
 	 */
 	abstract public function getLongWikiText( $linked = null );
 

includes/datavalues/SMW_DV_Number.php

Doc Comments +3 added lines, -3 removed lines

@@ -74,7 +74,7 @@ 
 	 * Parse a string of the form "number unit" where unit is optional. The
 	 * results are stored in the $number and $unit parameters. Returns an
 	 * error code.
-	 * @param $value string to parse
+	 * @param string $value string to parse
 	 * @param $number call-by-ref parameter that will be set to the numerical value
 	 * @param $unit call-by-ref parameter that will be set to the "unit" string (after the number)
 	 * @return integer 0 (no errors), 1 (no number found at all), 2 (number
@@ -186,7 +186,7 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @return integer
+	 * @return string
 	 */
 	public function getLocalizedFormattedNumberByPrecision( $value ) {
 		return NumberFormatter::getInstance()->getLocalizedFormattedNumber( $value, $this->getPrecision() );
@@ -195,7 +195,7 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @return integer
+	 * @return string
 	 */
 	public function getUnformattedNumberByPrecision( $value ) {
 		return NumberFormatter::getInstance()->getUnformattedNumberByPrecision( $value, $this->getPrecision() );

src/DataValues/TemperatureValue.php

Doc Comments +6 added lines

@@ -176,6 +176,9 @@ 
 		return $this->getUnitID( $unit );
 	}
 
+	/**
+	 * @param string|false $unit
+	 */
 	private function convertToKelvin( $number, $unit ) {
 
 		switch ( $unit ) {
@@ -195,6 +198,9 @@ 
 		return false; // unsupported unit
 	}
 
+	/**
+	 * @param string|false $unit
+	 */
 	private function convertToUnit( $number, $unit ) {
 
 		switch ( $unit ) {

src/PropertySpecificationLookup.php

Doc Comments +9 added lines

@@ -203,6 +203,9 @@ 
 		return $propertyDescription;
 	}
 
+	/**
+	 * @param DIProperty $property
+	 */
 	private function getPredefinedPropertyDescription( $property, $linker ) {
 
 		$description = '';
@@ -219,6 +222,9 @@ 
 		return $linker === null ? $message->escaped() : $message->parse();
 	}
 
+	/**
+	 * @param DIProperty $property
+	 */
 	private function tryToFindLocalPropertyDescription( $property, $linker ) {
 
 		$description = '';
@@ -235,6 +241,9 @@ 
 		return $description;
 	}
 
+	/**
+	 * @param string $languageCode
+	 */
 	private function findDataValueByLanguage( $dataItems, $languageCode ) {
 
 		if ( $dataItems === null || $dataItems === array() ) {

includes/SMW_Infolink.php

Doc Comments +6 added lines, -4 removed lines

@@ -76,7 +76,7 @@ 
 	 *
 	 * @param string $caption The label for the link.
 	 * @param string $target The actual link target.
-	 * @param mixed $style CSS class of a span to embedd the link into, or false if no extra style is required.
+	 * @param string|false $style CSS class of a span to embedd the link into, or false if no extra style is required.
 	 * @param array $params Array of parameters, format $name => $value, if any.
 	 *
 	 * @return SMWInfolink
@@ -125,8 +125,8 @@ 
 	 *
 	 * @param string $caption The label for the link.
 	 * @param string $subject
-	 * @param string $propertyName
-	 * @param mixed $style CSS class of a span to embed the link into, or false if no extra style is required.
+	 * @param string $propertyname
+	 * @param string $style CSS class of a span to embed the link into, or false if no extra style is required.
 	 *
 	 * @return SMWInfolink
 	 */
@@ -145,7 +145,7 @@ 
 	 *
 	 * @param string $caption The label for the link.
 	 * @param string $titleText
-	 * @param mixed $style CSS class of a span to embedd the link into, or false if no extra style is required.
+	 * @param string $style CSS class of a span to embedd the link into, or false if no extra style is required.
 	 *
 	 * @return SMWInfolink
 	 */
@@ -188,6 +188,7 @@ 
 
 	/**
 	 * Change the link text.
+	 * @param string|false $caption
 	 */
 	public function setCaption( $caption ) {
 		$this->mCaption = $caption;
@@ -195,6 +196,7 @@ 
 
 	/**
 	 * Change the link's CSS class.
+	 * @param string $style
 	 */
 	public function setStyle( $style ) {
 		$this->mStyle = $style;

includes/specials/SMW_SpecialAsk.php

Doc Comments +1 added lines

@@ -750,6 +750,7 @@
 
 	/**
 	 * FIXME MW 1.25
+	 * @param string $key
 	 */
 	private function addExternalHelpLinkFor( $key ) {