SemanticMediaWiki / SemanticMediaWiki

includes/storage/SMW_ResultArray.php

Doc Comments +2 added lines, -2 removed lines

@@ -134,7 +134,7 @@ 
 	 *
 	 * @since 1.6
 	 *
-	 * @return SMWDataItem|false
+	 * @return null|DataItem
 	 */
 	public function getNextDataItem() {
 		$this->loadContent();
@@ -267,7 +267,7 @@ 
 	 *
 	 * @param boolean $useLimit
 	 *
-	 * @return SMWRequestOptions|null
+	 * @return SMW\RequestOptions|null
 	 */
 	protected function getRequestOptions( $useLimit = true ) {
 		return $this->resultFieldMatchFinder->getRequestOptions( $useLimit );

src/Query/Result/EntityListAccumulator.php

Doc Comments +1 added lines

@@ -63,6 +63,7 @@
 	/**
 	 * @since  2.4
 	 *
+	 * @param string $queryID
 	 * @return array
 	 */
 	public function getEntityList( $queryID = null ) {

src/DataValues/PropertyChainValue.php

Doc Comments +5 added lines, -1 removed lines

@@ -76,6 +76,7 @@ 
 
 	/**
 	 * @see DataValue::getShortWikiText
+	 * @param string $linker
 	 */
 	public function getShortWikiText( $linker = null ) {
 
@@ -88,6 +89,7 @@ 
 
 	/**
 	 * @see DataValue::getLongWikiText
+	 * @param string $linker
 	 */
 	public function getLongWikiText( $linker = null ) {
 
@@ -154,7 +156,6 @@ 
 	 * @see DataValue::parseUserValue
 	 * @note called by DataValue::setUserValue
 	 *
-	 * @param string $userValue
 	 */
 	protected function parseUserValue( $value ) {
 
@@ -171,6 +172,9 @@ 
 		$this->m_dataitem = new DIBlob( $value );
 	}
 
+	/**
+	 * @param string $value
+	 */
 	private function initPropertyChain( $value ) {
 
 		$chain = explode( '.', $value );

src/SPARQLStore/QueryEngine/DescriptionInterpreters/ClassDescriptionInterpreter.php

Doc Comments +6 added lines

@@ -82,6 +82,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $joinVariable
+	 */
 	private function mapCategoriesToConditionElements( array $categories, $joinVariable ) {
 
 		$condition = '';
@@ -109,6 +112,9 @@ 
 		return array( $condition, $namespaces );
 	}
 
+	/**
+	 * @param string $categoryExpName
+	 */
 	private function tryToAddClassHierarchyPattern( $category, &$categoryExpName ) {
 
 		if ( !$this->compoundConditionBuilder->canUseQFeature( SMW_SPARQL_QF_SUBC ) ) {

src/SPARQLStore/QueryEngine/DescriptionInterpreters/ConjunctionInterpreter.php

Doc Comments +10 added lines

@@ -100,6 +100,10 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $joinVariable
+	 * @param \SMW\DIProperty|null $orderByProperty
+	 */
 	private function doPreliminarySubDescriptionCheck( $subDescriptions, $joinVariable, $orderByProperty ) {
 
 		$count = count( $subDescriptions );
@@ -126,6 +130,9 @@ 
 		return null;
 	}
 
+	/**
+	 * @param string $joinVariable
+	 */
 	private function doResolveSubDescriptionsRecursively( $subDescriptions, $joinVariable ) {
 
 		// Using a stdClass as data container for simpler handling in follow-up tasks
@@ -195,6 +202,9 @@ 
 		return $subConditionElements;
 	}
 
+	/**
+	 * @param \stdClass $subConditionElements
+	 */
 	private function createConditionFromSubConditionElements( $subConditionElements ) {
 
 		if ( $subConditionElements->singletonMatchElement instanceof ExpElement ) {

src/SPARQLStore/QueryEngine/DescriptionInterpreters/DisjunctionInterpreter.php

Doc Comments +11 added lines

@@ -107,6 +107,10 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $joinVariable
+	 * @param \SMW\DIProperty|null $orderByProperty
+	 */
 	private function doPreliminarySubDescriptionCheck( $subDescriptions, $joinVariable, $orderByProperty ) {
 
 		$count = count( $subDescriptions );
@@ -131,6 +135,10 @@ 
 		return null;
 	}
 
+	/**
+	 * @param string $joinVariable
+	 * @param \SMW\DIProperty|null $orderByProperty
+	 */
 	private function doResolveSubDescriptionsRecursively( $subDescriptions, $joinVariable, $orderByProperty ) {
 
 		// Using a stdClass as data container for simpler handling in follow-up tasks
@@ -213,6 +221,9 @@ 
 		return $subConditionElements;
 	}
 
+	/**
+	 * @param string $joinVariable
+	 */
 	private function createConditionFromSubConditionElements( $subConditionElements, $joinVariable ) {
 
 		if ( $subConditionElements->unionCondition === '' ) {

src/SPARQLStore/QueryEngine/DescriptionInterpreters/SomePropertyInterpreter.php

Doc Comments +10 added lines

@@ -150,6 +150,10 @@ 
 		return array( $innerOrderByProperty, $innerCondition, $innerJoinVariable );
 	}
 
+	/**
+	 * @param \SMW\SPARQLStore\QueryEngine\Condition\Condition $innerCondition
+	 * @param string $innerJoinVariable
+	 */
 	private function findObjectNameFromInnerCondition( $innerCondition, $innerJoinVariable, &$namespaces ) {
 
 		if ( !$innerCondition instanceof SingletonCondition ) {
@@ -201,6 +205,10 @@ 
 		return TurtleSerializer::getTurtleNameForExpElement( $propertyExpElement );
 	}
 
+	/**
+	 * @param string $objectName
+	 * @param string $joinVariable
+	 */
 	private function doExchangeForWhenInversePropertyIsUsed( DIProperty $property, $objectName, $joinVariable ) {
 
 		$subjectName = '?' . $joinVariable;
@@ -239,6 +247,8 @@ 
 	 * can be found using the "zero or more" will resolve the complete path
 	 *
 	 * @see http://www.w3.org/TR/sparql11-query/#propertypath-arbitrary-length
+	 * @param \SMW\SPARQLStore\QueryEngine\Condition\Condition $condition
+	 * @param string $propertyName
 	 */
 	private function tryToAddPropertyPathForSaturatedHierarchy( &$condition, DIProperty $property, &$propertyName ) {
 

src/SPARQLStore/QueryEngine/DescriptionInterpreters/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 ) {

src/SQLStore/QueryEngine/DescriptionInterpreters/DispatchingDescriptionInterpreter.php

Doc Comments +1 added lines, -2 removed lines

@@ -44,7 +44,7 @@ 
 	/**
 	 * @param Description $description
 	 *
-	 * @return QuerySegment
+	 * @return \SMW\SQLStore\QueryEngine\QuerySegment
 	 * @throws InvalidArgumentException
 	 */
 	public function interpretDescription( Description $description ) {
@@ -63,7 +63,6 @@ 
 	/**
 	 * @since  2.2
 	 *
-	 * @param DescriptionInterpreter $defaultInterpreter
 	 */
 	public function addInterpreter( DescriptionInterpreter $interpreter ) {
 		$this->interpreters[] = $interpreter;