SemanticMediaWiki / SemanticMediaWiki

includes/datavalues/SMW_DataValue.php

Doc Comments +5 added lines, -6 removed lines

@@ -176,7 +176,7 @@ 
 	 * label for printout might also be specified.
 	 *
 	 * @param string $value
-	 * @param mixed $caption
+	 * @param boolean $caption
 	 */
 	public function setUserValue( $value, $caption = false ) {
 
@@ -278,7 +278,7 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @return DIWikiPage|null
+	 * @return SMWDIWikiPage
 	 */
 	public function getContextPage() {
 		return $this->m_contextPage;
@@ -320,7 +320,7 @@ 
 	 *
 	 * @param string $key
 	 *
-	 * @return mixed|false
+	 * @return string|false
 	 */
 	public function getOption( $key ) {
 
@@ -355,7 +355,6 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @param string $caption
 	 */
 	public function getCaption() {
 		return $this->m_caption;
@@ -433,7 +432,6 @@ 
 	 *
 	 * @param $parameters
 	 * @param integer|null $type
-	 * @param integer|null $language
 	 */
 	public function addErrorMsg( $parameters, $type = null ) {
 		$this->mErrors[Message::getHash( $parameters, $type )] = Message::encode( $parameters, $type );
@@ -492,7 +490,7 @@ 
 	 *
 	 * @param string $value
 	 *
-	 * @return Description
+	 * @return SMW\Query\Language\Description
 	 * @throws InvalidArgumentException
 	 */
 	public function getQueryDescription( $value ) {
@@ -585,6 +583,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

@@ -7,7 +7,6 @@
  * @defgroup SMWDataValues SMWDataValues
  * @ingroup SMW
  */
-use SMW\ApplicationFactory;
 use SMW\DataValues\InfoLinksProvider;
 use SMW\Deserializers\DVDescriptionDeserializerRegistry;
 use SMW\Localizer;

includes/datavalues/SMW_DV_Time.php

Doc Comments +17 added lines, -7 removed lines

@@ -176,14 +176,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.
 	 */
@@ -415,7 +418,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 ) {
@@ -666,6 +669,7 @@ 
 	 * @see SMWDataValue::getLongWikiText
 	 *
 	 * {@inheritDoc}
+	 * @return string
 	 */
 	public function getLongWikiText( $linker = null ) {
 		return $this->dataValueServiceFactory->getValueFormatter( $this )->format( DataValueFormatter::WIKI_LONG, $linker );
@@ -813,10 +817,16 @@ 
 		}
 	}
 
+	/**
+	 * @param string $value
+	 */
 	private function isInterpretableAsYearOnly( $value ) {
 		return strpos( $value, ' ' ) === false && is_numeric( strval( $value ) ) && ( strval( $value ) < 0 || strlen( $value ) < 6 );
 	}
 
+	/**
+	 * @param string $value
+	 */
 	private function isInterpretableAsTimestamp( $value ) {
 		// 1200-11-02T12:03:25 or 20120320055913
 		return ( ( strlen( $value ) > 4 && substr( $value, 10, 1 ) === 'T' ) || strlen( $value ) == 14 ) && wfTimestamp( TS_MW, $value ) !== false;

tests/phpunit/Unit/DataValues/InfoLinksProviderTest.php

Unused Use Statements -1 removed lines

@@ -9,7 +9,6 @@
 use SMW\Tests\TestEnvironment;
 use SMWNumberValue as NumberValue;
 use SMWStringValue as StringValue;
-use SMWTimeValue as TimeValue;
 
 /**
  * @covers \SMW\DataValues\InfoLinksProvider

src/DataTypeRegistry.php

Doc Comments +3 added lines, -4 removed lines

@@ -350,7 +350,7 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getCanonicalDatatypeLabels() {
 		return $this->canonicalLabels;
@@ -362,7 +362,7 @@ 
 	 * returned for internal types without user labels (e.g. the special types
 	 * for some special properties), and for user defined types.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getKnownTypeLabels() {
 		return $this->typeLabels;
@@ -371,7 +371,7 @@ 
 	/**
 	 * @since 2.1
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getKnownTypeAliases() {
 		return $this->typeAliases;
@@ -389,7 +389,6 @@ 
 	 *
 	 * @since 2.5
 	 *
-	 * @param string $diType
 	 *
 	 * @return string|null
 	 */

src/ApplicationFactory.php

Unused Use Statements -1 removed lines

@@ -12,7 +12,6 @@
 use SMW\MediaWiki\MwCollaboratorFactory;
 use SMW\MediaWiki\PageCreator;
 use SMW\MediaWiki\TitleCreator;
-use SMW\Query\ProfileAnnotator\QueryProfileAnnotatorFactory;
 use SMWQueryParser as QueryParser;
 use Title;
 use SMW\Services\SharedServicesContainer;

src/Query/Result/CachedQueryResultPrefetcher.php

Doc Comments +24 added lines, -2 removed lines

@@ -211,7 +211,6 @@ 
 	/**
 	 * @since 2.5
 	 *
-	 * @param QueryEngine $queryEngine
 	 */
 	public function disableCache() {
 		$this->enabledCache = false;
@@ -283,7 +282,6 @@ 
 	/**
 	 * @since 2.5
 	 *
-	 * @param DIWikiPage|array $list
 	 * @param string $context
 	 */
 	public function resetCacheBy( $item, $context = '' ) {
@@ -315,6 +313,11 @@ 
 		return $this->enabledCache && $this->blobStore->canUse() && ( $query->getContextPage() !== null || ( $query->getContextPage() === null && $this->nonEmbeddedCacheLifetime > 0 ) );
 	}
 
+	/**
+	 * @param string $queryId
+	 * @param Query $query
+	 * @param \Onoi\BlobStore\Container $container
+	 */
 	private function newQueryResultFromCache( $queryId, $query, $container ) {
 
 		$results = array();
@@ -376,6 +379,12 @@ 
 		return $queryResult;
 	}
 
+	/**
+	 * @param QueryResult $queryResult
+	 * @param string $queryId
+	 * @param \Onoi\BlobStore\Container $container
+	 * @param Query $query
+	 */
 	private function addQueryResultToCache( $queryResult, $queryId, $container, $query ) {
 
 		if ( ( $context = $query->getOption( Query::PROC_CONTEXT ) ) === false ) {
@@ -468,6 +477,9 @@ 
 		return md5( $subject . self::VERSION . $this->hashModifier );
 	}
 
+	/**
+	 * @param string $message
+	 */
 	private function log( $message, $context = array() ) {
 
 		if ( $this->logger === null ) {
@@ -477,6 +489,9 @@ 
 		$this->logger->info( $message, $context );
 	}
 
+	/**
+	 * @param Query $query
+	 */
 	private function getNoCacheId( $query ) {
 
 		$id = 'noCache.misc';
@@ -500,6 +515,9 @@ 
 		return $id;
 	}
 
+	/**
+	 * @param string $date
+	 */
 	private function initStats( $date ) {
 
 		$this->bufferedStatsdCollector->shouldRecord( $this->isEnabled() );
@@ -517,6 +535,10 @@ 
 	}
 
 	// http://stackoverflow.com/questions/3777995/php-array-recursive-sum
+
+	/**
+	 * @param integer $value
+	 */
 	private static function sum( $value, $container ) {
 		return $value + ( is_array( $container ) ? array_reduce( $container, 'self::sum' ) : $container );
 	}

src/SQLStore/RedirectInfoStore.php

Doc Comments +13 added lines

@@ -103,6 +103,10 @@ 
 		$this->inMemoryPoolCache->getPoolCacheById( 'sql.store.redirect.infostore' )->delete( $hash );
 	}
 
+	/**
+	 * @param string $title
+	 * @param integer $namespace
+	 */
 	private function select( $title, $namespace ) {
 
 		$row = $this->connection->selectRow(
@@ -118,6 +122,11 @@ 
 		return $row !== false && isset( $row->o_id ) ? (int)$row->o_id : 0;
 	}
 
+	/**
+	 * @param integer $id
+	 * @param string $title
+	 * @param integer $namespace
+	 */
 	private function insert( $id, $title, $namespace ) {
 
 		$this->connection->insert(
@@ -130,6 +139,10 @@ 
 		);
 	}
 
+	/**
+	 * @param string $title
+	 * @param integer $namespace
+	 */
 	private function delete( $title, $namespace ) {
 
 		$this->connection->delete(

src/DataValues/AllowsPatternValue.php

Doc Comments -3 removed lines

@@ -60,7 +60,6 @@ 
 	/**
 	 * @see DataValue::getShortWikiText
 	 *
-	 * @param string $value
 	 */
 	public function getShortWikiText( $linker = null ) {
 
@@ -76,7 +75,6 @@ 
 	/**
 	 * @see DataValue::getLongHtmlText
 	 *
-	 * @param string $value
 	 */
 	public function getLongHtmlText( $linker = null ) {
 		return $this->getShortHtmlText( $linker );
@@ -85,7 +83,6 @@ 
 	/**
 	 * @see DataValue::getShortHtmlText
 	 *
-	 * @param string $value
 	 */
 	public function getShortHtmlText( $linker = null ) {
 

includes/ParserData.php

Doc Comments +6 added lines, -2 removed lines

@@ -108,7 +108,7 @@ 
 	 *
 	 * @param string $key
 	 *
-	 * @return mixed
+	 * @return string|null
 	 */
 	public function getOption( $key ) {
 
@@ -220,6 +220,7 @@ 
 
 	/**
 	 * @since  1.9
+	 * @param string $error
 	 */
 	public function addError( $error ) {
 		$this->errors = array_merge( $this->errors, (array)$error );
@@ -353,7 +354,7 @@ 
 	 *
 	 * @since 1.9
 	 *
-	 * @param SMWDataValue $dataValue
+	 * @param DataValue $dataValue
 	 */
 	public function addDataValue( DataValue $dataValue ) {
 		$this->semanticData->addDataValue( $dataValue );
@@ -452,6 +453,9 @@ 
 		}
 	}
 
+	/**
+	 * @return SemanticData
+	 */
 	private function fetchDataFromParserOutput( ParserOutput $parserOutput ) {
 
 		if ( $this->hasExtensionData() ) {