SemanticMediaWiki / SemanticMediaWiki

src/NumberFormatter.php

Doc Comments +6 added lines, -3 removed lines

@@ -39,7 +39,6 @@ 
 	/**
 	 * @since 2.1
 	 *
-	 * @param Language $contentLanguage
 	 */
 	public function __construct( $maxNonExpNumber ) {
 		$this->maxNonExpNumber = $maxNonExpNumber;
@@ -48,7 +47,7 @@ 
 	/**
 	 * @since 2.1
 	 *
-	 * @return Localizer
+	 * @return NumberFormatter
 	 */
 	public static function getInstance() {
 
@@ -92,7 +91,7 @@ 
 	 * @since 2.4
 	 *
 	 * @param mixed $value input number
-	 * @param integer|false $precision
+	 * @param integer $precision
 	 *
 	 * @return string
 	 */
@@ -238,6 +237,10 @@ 
 		return $this->decimalSeparatorInUserLanguage;
 	}
 
+	/**
+	 * @param string $decimal
+	 * @param string $thousand
+	 */
 	private function doFormatByPrecision( $value, $precision = false, $decimal, $thousand ) {
 		// Format to some level of precision; number_format does rounding and
 		// locale formatting, x and y are used temporarily since number_format

includes/specials/SMW_SpecialTypes.php

Doc Comments +3 added lines

@@ -141,6 +141,9 @@
 		return 'pages';
 	}
 
+	/**
+	 * @param SMWDataValue $typeValue
+	 */
 	private function displayExtraInformationAbout( $typeValue ) {
 
 		$html = '';

src/DataValueFactory.php

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use SMWDataItem;
 use SMWDIError;
 use SMWErrorValue as ErrorValue;
-use SMWPropertyValue;
 use SMWDataValue as DataValue;
 
 /**

Doc Comments +9 added lines, -3 removed lines

@@ -139,7 +139,7 @@ 
 	 * @param $property SMWDIProperty property object for which this value is made
 	 * @param $valueString mixed user value string, or false if unknown
 	 * @param $caption mixed user-defined caption, or false if none given
-	 * @param $contextPage SMWDIWikiPage that provides a context for parsing the value string, or null
+	 * @param DIWikiPage $contextPage SMWDIWikiPage that provides a context for parsing the value string, or null
 	 *
 	 * @return DataValue
 	 */
@@ -160,7 +160,7 @@ 
 	 * @param string $propertyName property string
 	 * @param string $valueString user value string
 	 * @param mixed $caption user-defined caption
-	 * @param SMWDIWikiPage|null $contextPage context for parsing the value string
+	 * @param null|DIWikiPage $contextPage context for parsing the value string
 	 *
 	 * @return DataValue
 	 */
@@ -245,6 +245,8 @@ 
 	/**
 	 * @deprecated since 2.4, use DataTypeRegistry::newPropertyObjectValueByText
 	 *
+	 * @param string $propertyName
+	 * @param string $valueString
 	 * @return DataValue
 	 */
 	public function newPropertyValue( $propertyName, $valueString,
@@ -255,7 +257,7 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @param string $propertyName
+	 * @param string $propertyLabel
 	 *
 	 * @return DataValue
 	 */
@@ -265,6 +267,8 @@ 
 
 	/**
 	 * @deprecated since 1.9, use DataTypeRegistry::registerDataType
+	 * @param string $id
+	 * @param string $className
 	 */
 	public static function registerDatatype( $id, $className, $dataItemId, $label = false ) {
 		DataTypeRegistry::getInstance()->registerDataType( $id, $className, $dataItemId, $label );
@@ -272,6 +276,8 @@ 
 
 	/**
 	 * @deprecated since 1.9, use DataTypeRegistry::registerDataTypeAlias
+	 * @param string $id
+	 * @param string $label
 	 */
 	public static function registerDatatypeAlias( $id, $label ) {
 		DataTypeRegistry::getInstance()->registerDataTypeAlias( $id, $label );

tests/phpunit/includes/DataValues/PropertyValueTest.php

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use SMW\SPARQLStore\QueryEngine\QueryEngine;
 use SMW\SPARQLStore\QueryEngine\EngineOptions;
 use SMW\SPARQLStore\QueryEngine\QueryResultFactory;
-use SMW\DIProperty;
 use SMWQuery as Query;
 
 /**

includes/datavalues/SMW_DV_Property.php

Doc Comments +5 added lines, -1 removed lines

@@ -71,7 +71,7 @@ 
 	 * the provided name is not allowed. An object is returned
 	 * in any case.
 	 *
-	 * @param string $propertyName
+	 * @param string $propertyLabel
 	 *
 	 * @return SMWPropertyValue
 	 */
@@ -192,6 +192,9 @@ 
 		}
 	}
 
+	/**
+	 * @param boolean $isinverse
+	 */
 	public function setInverse( $isinverse ) {
 		return $this->m_dataitem = new SMWDIProperty( $this->m_dataitem->getKey(), ( $isinverse == true ) );
 	}
@@ -319,6 +322,7 @@ 
 
 	/**
 	 * Create special highlighting for hinting at special properties.
+	 * @param string $text
 	 */
 	protected function highlightText( $text, $linker = null ) {
 

src/DataValues/LanguageCodeValue.php

Doc Comments -1 removed lines

@@ -29,7 +29,6 @@
 	/**
 	 * @see DataValue::parseUserValue
 	 *
-	 * @param string $value
 	 */
 	protected function parseUserValue( $userValue ) {
 

src/DataValues/ValueParsers/MonolingualTextValueParser.php

Unused Use Statements -2 removed lines

@@ -3,9 +3,7 @@
 namespace SMW\DataValues\ValueParsers;
 
 use SMW\DataValues\MonolingualTextValue;
-use SMW\DataValueFactory;
 use SMW\Localizer;
-use SMWDataValue as DataValue;
 
 /**
  * @private

src/Localizer.php

Doc Comments -1 removed lines

@@ -31,7 +31,6 @@
 	 * @since 2.1
 	 *
 	 * @param Language $contentLanguage
-	 * @param Language|null $userLanguage
 	 */
 	public function __construct( Language $contentLanguage) {
 		$this->contentLanguage = $contentLanguage;

includes/datavalues/SMW_DataValue.php

Doc Comments +8 added lines, -7 removed lines

@@ -174,7 +174,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 ) {
@@ -256,7 +256,7 @@ 
 	 *
 	 * @since 1.8
 	 *
-	 * @return SMWDIProperty|null
+	 * @return SMWDIProperty
 	 */
 	public function getProperty() {
 		return $this->m_property;
@@ -278,7 +278,7 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @return DIWikiPage|null
+	 * @return SMWDIWikiPage
 	 */
 	public function getContextPage() {
 		return $this->m_contextPage;
@@ -298,7 +298,7 @@ 
 	 *
 	 * @param string $key
 	 *
-	 * @return mixed|false
+	 * @return string|false
 	 */
 	public function getOptionValueFor( $key ) {
 
@@ -322,7 +322,6 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @param string $caption
 	 */
 	public function getCaption() {
 		return $this->m_caption;
@@ -490,7 +489,7 @@ 
 	 *
 	 * @param string $value
 	 *
-	 * @return Description
+	 * @return SMW\Query\Language\Description
 	 * @throws InvalidArgumentException
 	 */
 	public function getQueryDescription( $value ) {
@@ -511,7 +510,7 @@ 
 	 *
 	 * @since 2.4
 	 *
-	 * @return DataValueFormatter
+	 * @return SMW\DataValues\ValueFormatters\DataValueFormatter
 	 */
 	public function getDataValueFormatter() {
 		return ValueFormatterRegistry::getInstance()->getDataValueFormatterFor( $this );
@@ -585,6 +584,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 );
 
@@ -595,6 +595,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 );