SemanticMediaWiki / SemanticMediaWiki

src/Maintenance/DataRebuilder.php

Doc Comments +14 added lines, -1 removed lines

@@ -305,6 +305,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param double $byIdDataRebuildDispatcher
+	 */
 	private function doExecuteFor( $byIdDataRebuildDispatcher, &$id ) {
 
 		if ( !$this->options->has( 'ignore-exceptions' ) ) {
@@ -388,6 +391,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param double $byIdDataRebuildDispatcher
+	 */
 	private function deleteMarkedSubjects( $byIdDataRebuildDispatcher ) {
 
 		$matches = array();
@@ -421,6 +427,9 @@ 
 		$this->reportMessage( "\n\n{$matchesCount} IDs removed.\n\n" );
 	}
 
+	/**
+	 * @param string $startIdFile
+	 */
 	private function idFileIsWritable( $startIdFile ) {
 
 		if ( !is_writable( file_exists( $startIdFile ) ? $startIdFile : dirname( $startIdFile ) ) ) {
@@ -437,7 +446,7 @@ 
 	}
 
 	/**
-	 * @param array $options
+	 * @param Options $options
 	 */
 	private function setFiltersFromOptions( Options $options ) {
 		$this->filters = array();
@@ -457,6 +466,10 @@ 
 		}
 	}
 
+	/**
+	 * @param boolean $verbose
+	 * @param string $progress
+	 */
 	private function doPrintDotProgressIndicator( $verbose, $progress ) {
 
 		if ( ( $this->rebuildCount - 1 ) % 60 === 0 ) {

includes/dataitems/SMW_DI_Property.php

Doc Comments +5 added lines

@@ -259,6 +259,7 @@ 
 	/**
 	 * @since  2.0
 	 *
+	 * @param string $propertyTypeId
 	 * @return self
 	 * @throws RuntimeException
 	 * @throws InvalidArgumentException
@@ -391,6 +392,7 @@ 
 
 	/**
 	 * @deprecated since 2.1, use PropertyRegistry::findPropertyIdByLabel
+	 * @param string $label
 	 */
 	public static function findPropertyID( $label, $useAlias = true ) {
 		return PropertyRegistry::getInstance()->findPropertyIdByLabel( $label, $useAlias );
@@ -424,6 +426,9 @@ 
 		PropertyRegistry::getInstance()->registerPropertyAlias( $id, $label );
 	}
 
+	/**
+	 * @param string $subobjectName
+	 */
 	private function newDIWikiPage( $dbkey, $subobjectName ) {
 
 		// If an inverse marker is present just omit the marker so a normal

src/DataTypeRegistry.php

Doc Comments +3 added lines, -3 removed lines

@@ -322,7 +322,7 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getCanonicalDatatypeLabels() {
 		return $this->canonicalLabels;
@@ -334,7 +334,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;
@@ -343,7 +343,7 @@ 
 	/**
 	 * @since 2.1
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getKnownTypeAliases() {
 		return $this->typeAliases;

src/NumberFormatter.php

Doc Comments +6 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
 	/**
 	 * @since 2.1
 	 *
-	 * @return Localizer
+	 * @return NumberFormatter
 	 */
 	public static function getInstance() {
 
@@ -102,7 +102,7 @@ 
 	 * @since 2.4
 	 *
 	 * @param mixed $value input number
-	 * @param integer|false $precision
+	 * @param integer $precision
 	 *
 	 * @return string
 	 */
@@ -248,6 +248,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

src/PropertyRegistry.php

Doc Comments +5 added lines, -1 removed lines

@@ -123,7 +123,7 @@ 
 	/**
 	 * @since 2.1
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getKnownPropertyAliases() {
 		return $this->propertyAliasFinder->getKnownPropertyAliases();
@@ -267,6 +267,7 @@ 
 
 	/**
 	 * @deprecated since 2.1 use findPropertyIdByLabel instead
+	 * @param string $label
 	 */
 	public function findPropertyId( $label, $useAlias = true ) {
 		return $this->findPropertyIdByLabel( $label, $useAlias );
@@ -369,6 +370,9 @@ 
 		\Hooks::run( 'SMW::Property::initProperties', array( $this ) );
 	}
 
+	/**
+	 * @param string|boolean $label
+	 */
 	private function registerPropertyLabel( $id, $label, $asCanonical = true ) {
 		$this->propertyLabelFinder->registerPropertyLabel( $id, $label, $asCanonical );
 	}

src/SPARQLStore/QueryEngine/Interpreter/ValueDescriptionInterpreter.php

Doc Comments +19 added lines

@@ -104,10 +104,18 @@ 
 		);
 	}
 
+	/**
+	 * @param string $joinVariable
+	 * @param \SMW\DIProperty|null $orderByProperty
+	 */
 	private function createConditionForEmptyComparator( $joinVariable, $orderByProperty ) {
 		return $this->compoundConditionBuilder->newTrueCondition( $joinVariable, $orderByProperty );
 	}
 
+	/**
+	 * @param string $joinVariable
+	 * @param \SMW\DIProperty|null $orderByProperty
+	 */
 	private function createConditionForEqualityComparator( $dataItem, $property, $joinVariable, $orderByProperty ) {
 
 		$expElement = $this->exporter->getDataItemHelperExpElement( $dataItem );
@@ -153,6 +161,11 @@ 
 		return $condition;
 	}
 
+	/**
+	 * @param string $joinVariable
+	 * @param \SMW\DIProperty|null $orderByProperty
+	 * @param string $comparator
+	 */
 	private function createConditionForRegexComparator( $dataItem, $joinVariable, $orderByProperty, $comparator ) {
 
 		if ( !$dataItem instanceof DIBlob && !$dataItem instanceof DIWikiPage && !$dataItem instanceof DIUri ) {
@@ -196,6 +209,9 @@ 
 		return $condition;
 	}
 
+	/**
+	 * @param string $comparator
+	 */
 	private function createFilterConditionForAnyOtherComparator( $dataItem, $joinVariable, $orderByProperty, $comparator ) {
 
 		$result = new FilterCondition( '', array() );
@@ -228,6 +244,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $pattern
+	 */
 	private function createFilterConditionToMatchRegexPattern( $dataItem, &$joinVariable, $comparator, $pattern ) {
 
 		if ( $dataItem instanceof DIBlob ) {

includes/export/SMW_Exporter.php

Doc Comments +3 added lines, -3 removed lines

@@ -392,7 +392,7 @@ 
 	 * represent. Returns null if this attempt failed.
 	 *
 	 * @param SMWExpElement $expElement
-	 * @return SMWDataItem or null
+	 * @return null|DIWikiPage or null
 	 */
 	public function findDataItemForExpElement( SMWExpElement $expElement ) {
 		return self::$dataItemByExpElementMatchFinder->tryToFindDataItemForExpElement( $expElement );
@@ -429,7 +429,7 @@ 
 	 * must take the type of the annotated object into account for some
 	 * reason.
 	 *
-	 * @param $propertyKey string the Id of the special property
+	 * @param string $propertyKey string the Id of the special property
 	 * @param $forNamespace integer the namespace of the page which has a value for this property
 	 * @return ExpNsResource|null
 	 */
@@ -609,7 +609,7 @@ 
 	 * elements are always preferred in query answering.
 	 *
 	 * @param $dataItem SMWDataItem
-	 * @return SMWExpElement or null
+	 * @return SMWExpLiteral|null or null
 	 */
 	static public function getDataItemHelperExpElement( SMWDataItem $dataItem ) {
 

src/Exporter/ConceptToExpDataMapper.php

Doc Comments +1 added lines, -1 removed lines

@@ -119,7 +119,7 @@
 	 *
 	 * @param string &$exact
 	 *
-	 * @return Element|false
+	 * @return Element
 	 */
 	public function getExpDataFromDescription( Description $description, &$exact ) {
 

includes/NamespaceManager.php

Doc Comments +7 added lines

@@ -19,6 +19,7 @@ 
 	 *
 	 * @param array &$globalVars
 	 * @param string|null &directory
+	 * @param string $directory
 	 */
 	public function __construct( &$globalVars, $directory = null ) {
 		$this->globalVars =& $globalVars;
@@ -173,12 +174,18 @@ 
 
 	}
 
+	/**
+	 * @param string $element
+	 */
 	protected function isValidConfigurationOrSetDefault( $element, $default ) {
 		if ( !isset( $this->globalVars[$element] ) || !is_array( $this->globalVars[$element] ) ) {
 			$this->globalVars[$element] = $default;
 		}
 	}
 
+	/**
+	 * @param string $constant
+	 */
 	protected function isDefinedConstant( $constant ) {
 		return defined( $constant );
 	}