SemanticMediaWiki / SemanticMediaWiki

includes/datavalues/SMW_DataValue.php

Doc Comments +6 added lines, -7 removed lines

@@ -168,7 +168,7 @@ 
 	 * label for printout might also be specified.
 	 *
 	 * @param string $value
-	 * @param mixed $caption
+	 * @param boolean $caption
 	 */
 	public function setUserValue( $value, $caption = false ) {
 
@@ -263,7 +263,7 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @return DIWikiPage|null
+	 * @return SMWDIWikiPage
 	 */
 	public function getContextPage() {
 		return $this->m_contextPage;
@@ -305,7 +305,7 @@ 
 	 *
 	 * @param string $key
 	 *
-	 * @return mixed|false
+	 * @return string|false
 	 */
 	public function getOptionBy( $key ) {
 
@@ -340,7 +340,6 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @param string $caption
 	 */
 	public function getCaption() {
 		return $this->m_caption;
@@ -427,7 +426,6 @@ 
 	 *
 	 * @param $parameters
 	 * @param integer|null $type
-	 * @param integer|null $language
 	 */
 	public function addErrorMsg( $parameters, $type = null ) {
 		$this->mErrors[] = Message::encode( $parameters, $type );
@@ -484,7 +482,7 @@ 
 	 *
 	 * @param string|null $value
 	 *
-	 * @return Description
+	 * @return SMW\Query\Language\Description
 	 * @throws InvalidArgumentException
 	 */
 	public function getQueryDescription( $value = null ) {
@@ -510,7 +508,7 @@ 
 	 *
 	 * @since 2.4
 	 *
-	 * @return DataValueFormatter
+	 * @return SMW\DataValues\ValueFormatters\DataValueFormatter
 	 */
 	public function getDataValueFormatter() {
 		return ValueFormatterRegistry::getInstance()->getDataValueFormatterFor( $this );
@@ -594,6 +592,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 );
 

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 namespace SMW\Tests;
 
 use SMW\CacheFactory;
-use SMW\ApplicationFactory;
 
 /**
  * @covers \SMW\CacheFactory

src/DataValues/ValueValidators/ListConstraintValueValidator.php

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 
 namespace SMW\DataValues\ValueValidators;
 
-use SMW\DataValueFactory;
 use SMW\ApplicationFactory;
 use SMWDataValue as DataValue;
 use SMWDIBlob as DIBlob;

src/DataValues/ValueValidators/PatternConstraintValueValidator.php

Doc Comments +4 added lines

@@ -82,6 +82,10 @@
 		);
 	}
 
+	/**
+	 * @param string $pattern
+	 * @param string $reference
+	 */
 	private function doPregMatch( $pattern, $dataValue, $reference ) {
 
 		// Convert escaping as in /\d{4}

src/Query/PrintRequest/Formatter.php

Doc Comments +6 added lines

@@ -40,6 +40,9 @@ 
 		return self::getHTMLText( $printRequest, $linker );
 	}
 
+	/**
+	 * @param  $printRequest
+	 */
 	private static function getHTMLText( $printRequest, $linker = null ) {
 
 		$label = htmlspecialchars( $printRequest->getLabel() );
@@ -62,6 +65,9 @@ 
 		}
 	}
 
+	/**
+	 * @param  $printRequest
+	 */
 	private static function getWikiText( $printRequest, $linker = false ) {
 
 		$label = $printRequest->getLabel();

src/Query/PrintRequest/Serializer.php

Doc Comments +16 added lines

@@ -49,6 +49,10 @@ 
 		return ''; // no current serialisation
 	}
 
+	/**
+	 * @param  $printRequest
+	 * @param string $parameters
+	 */
 	private static function doSerializeCat( $printRequest, $parameters ) {
 
 		$catlabel = Localizer::getInstance()->getNamespaceTextById( NS_CATEGORY );
@@ -61,6 +65,10 @@ 
 		return $result . $parameters;
 	}
 
+	/**
+	 * @param  $printRequest
+	 * @param string $parameters
+	 */
 	private static function doSerializeCcat( $printRequest, $parameters ) {
 
 		$printname = $printRequest->getData()->getPrefixedText();
@@ -77,6 +85,10 @@ 
 		return $result . $parameters;
 	}
 
+	/**
+	 * @param  $printRequest
+	 * @param string $parameters
+	 */
 	private static function doSerializeProp( $printRequest, $parameters ) {
 
 		$printname = '';
@@ -106,6 +118,10 @@ 
 		return $result . $parameters;
 	}
 
+	/**
+	 * @param  $printRequest
+	 * @param string $parameters
+	 */
 	private static function doSerializeThis( $printRequest, $parameters ) {
 
 		$result = '?';

src/DataItemFactory.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -9,7 +9,7 @@
 use SMWDIError as DIError;
 use SMWDINumber as DINumber;
 use SMWDIUri as DIUri;
-use SMWDITime  as DITime;
+use SMWDITime as DITime;
 
 /**
  * @private

Doc Comments +2 added lines, -2 removed lines

@@ -136,8 +136,8 @@
 	 *
 	 * @param integer $calendarmodel
 	 * @param integer $year
-	 * @param integer|false $month
-	 * @param integer|false $day
+	 * @param integer $month
+	 * @param integer $day
 	 * @param integer|false $hour
 	 * @param integer|false $minute
 	 * @param integer|false $second

src/Deserializers/DVDescriptionDeserializer/DescriptionDeserializer.php

Doc Comments +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
 	 * @since 2.5
 	 *
 	 * @param DescriptionFactory|null $descriptionFactory
-	 * @param DataItemFactory|null $dataItemFactory
+	 * @param null|DescriptionFactory $dataItemFactory
 	 */
 	public function __construct( DescriptionFactory $descriptionFactory = null, DescriptionFactory $dataItemFactory = null ) {
 		$this->descriptionFactory = $descriptionFactory;

src/Deserializers/DVDescriptionDeserializer/SomeValueDescriptionDeserializer.php

Doc Comments +4 added lines

@@ -77,6 +77,10 @@
 		return $description;
 	}
 
+	/**
+	 * @param DIWikiPage $dataItem
+	 * @param ValueDescription $description
+	 */
 	private function findApproriateDescription( $comparator, $dataItem, $description ) {
 
 		$value = $dataItem->getDBKey();

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 namespace SMW\Deserializers\DVDescriptionDeserializer;
 
 use InvalidArgumentException;
-use SMW\Query\Language\ThingDescription;
 use SMW\Query\Language\ValueDescription;
 use SMWDataValue as DataValue;
 use SMW\DIWikiPage;

includes/dataitems/SMW_DI_Time.php

Doc Comments +8 added lines, -3 removed lines

@@ -327,7 +327,7 @@ 
 	 *
 	 * @param string $timestamp must be in format
 	 *
-	 * @return SMWDITime|false
+	 * @return SMWDataItem
 	 */
 	public static function newFromTimestamp( $timestamp ) {
 		$timestamp = wfTimestamp( TS_MW, (string)$timestamp );
@@ -494,10 +494,10 @@ 
 	 * calendar model, presicion.
 	 *
 	 * @param double $jdValue
-	 * @param integer|null $calendarmodel
+	 * @param integer|null $calendarModel
 	 * @param integer|null $precision
 	 *
-	 * @return DITime object
+	 * @return SMWDITime object
 	 */
 	public static function newFromJD( $jdValue, $calendarModel = null, $precision = null ) {
 
@@ -579,6 +579,11 @@ 
 		return $this->m_day > self::getDayNumberForMonth( $this->m_month, $this->m_year, $this->m_model );
 	}
 
+	/**
+	 * @param boolean $month
+	 * @param boolean $day
+	 * @param boolean $hour
+	 */
 	private function setPrecisionLevelBy( $month, $day, $hour ) {
 		if ( $month === false ) {
 			$this->m_precision = self::PREC_Y;