SemanticMediaWiki / SemanticMediaWiki

tests/phpunit/TestEnvironment.php

Doc Comments +2 added lines, -2 removed lines

@@ -183,7 +183,7 @@ 
 	/**
 	 * @since 2.5
 	 *
-	 * @param $originalClassName
+	 * @param string $originalClassName
 	 * @param array $configuration
 	 *
 	 * @return PHPUnit_Framework_MockObject_MockObject
@@ -228,7 +228,7 @@ 
 	 * @since 2.5
 	 *
 	 * @param integer $index
-	 * @param string $url
+	 * @param string $text
 	 *
 	 * @return string
 	 */

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use SMW\ApplicationFactory;
 use SMW\DataValueFactory;
 use SMW\DeferredCallableUpdate;
-use SMW\Store;
 use SMW\Localizer;
 use SMW\Tests\Utils\UtilityFactory;
 use SMW\Tests\Utils\Mock\ConfigurableStub;

includes/dataitems/SMW_DI_Property.php

Doc Comments +5 added lines

@@ -307,6 +307,7 @@ 
 	/**
 	 * @since  2.0
 	 *
+	 * @param string $propertyTypeId
 	 * @return self
 	 * @throws PropertyDataTypeLookupExeption
 	 * @throws InvalidArgumentException
@@ -460,6 +461,7 @@ 
 
 	/**
 	 * @deprecated since 2.1, use PropertyRegistry::findPropertyIdByLabel
+	 * @param string $label
 	 */
 	public static function findPropertyID( $label, $useAlias = true ) {
 		return PropertyRegistry::getInstance()->findPropertyIdByLabel( $label, $useAlias );
@@ -493,6 +495,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

includes/dataitems/SMW_DI_Time.php

Doc Comments +8 added lines, -3 removed lines

@@ -335,7 +335,7 @@ 
 	 *
 	 * @param string $timestamp must be in format
 	 *
-	 * @return SMWDITime|false
+	 * @return SMWDataItem
 	 */
 	public static function newFromTimestamp( $timestamp ) {
 		$timestamp = wfTimestamp( TS_MW, (string)$timestamp );
@@ -508,10 +508,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, $timezone = false ) {
 
@@ -593,6 +593,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;

includes/datavalues/SMW_DataValue.php

Unused Use Statements -1 removed lines

@@ -7,7 +7,6 @@
  * @defgroup SMWDataValues SMWDataValues
  * @ingroup SMW
  */
-use SMW\ApplicationFactory;
 use SMW\DataValues\InfoLinksProvider;
 use SMW\DataValues\ValueFormatterRegistry;
 use SMW\DataValues\ValueValidatorRegistry;

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 getOption( $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::getHash( $parameters, $type )] = Message::encode( $parameters, $type );
@@ -486,7 +484,7 @@ 
 	 *
 	 * @param string $value
 	 *
-	 * @return Description
+	 * @return SMW\Query\Language\Description
 	 * @throws InvalidArgumentException
 	 */
 	public function getQueryDescription( $value ) {
@@ -507,7 +505,7 @@ 
 	 *
 	 * @since 2.4
 	 *
-	 * @return DataValueFormatter
+	 * @return SMW\DataValues\ValueFormatters\DataValueFormatter
 	 */
 	public function getDataValueFormatter() {
 		return ValueFormatterRegistry::getInstance()->getDataValueFormatterFor( $this );
@@ -591,6 +589,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 );
 

includes/datavalues/SMW_DV_String.php

Doc Comments +4 added lines, -1 removed lines

@@ -34,7 +34,7 @@ 
 	/**
 	 * @see DataValue::loadDataItem
 	 *
-	 * @param SMWDataItem $dataitem
+	 * @param SMWDataItem $dataItem
 	 *
 	 * @return boolean
 	 */
@@ -96,6 +96,9 @@ 
 		return $this->getDataValueFormatter()->format( DataValueFormatter::VALUE );
 	}
 
+	/**
+	 * @param integer $length
+	 */
 	public function getWikiValueByLengthOf( $length ) {
 
 		if ( mb_strlen( $this->getWikiValue() ) > $length ) {

includes/datavalues/SMW_DV_URI.php

Doc Comments +7 added lines

@@ -45,6 +45,9 @@ 
 	 */
 	private $showUrlContextInRawFormat = true;
 
+	/**
+	 * @param string $typeid
+	 */
 	public function __construct( $typeid ) {
 		parent::__construct( $typeid );
 		switch ( $typeid ) {
@@ -182,6 +185,7 @@ 
 	 * Returns true if the argument is a valid RFC 3966 phone number.
 	 * Only global phone numbers are supported, and no full validation
 	 * of parameters (appended via ;param=value) is performed.
+	 * @param string $s
 	 */
 	protected static function isValidTelURI( $s ) {
 		$tel_uri_regex = '<^tel:\+[0-9./-]*[0-9][0-9./-]*(;[0-9a-zA-Z-]+=(%[0-9a-zA-Z][0-9a-zA-Z]|[0-9a-zA-Z._~:/?#[\]@!$&\'()*+,;=-])*)*$>';
@@ -340,6 +344,9 @@ 
 		return str_replace( ':', '&#58;', $url );
 	}
 
+	/**
+	 * @param string $context
+	 */
 	private function decodeUriContext( $context, $linker ) {
 
 		// Prior to decoding turn any `-` into an internal representation to avoid

includes/query/SMW_QueryParser.php

Doc Comments +9 added lines

@@ -142,6 +142,7 @@ 
 	 * but just controls query generation. For general effect, the default namespaces
 	 * should be set to NULL.
 	 *
+	 * @param boolean $setNS
 	 * @return Description|null
 	 */
 	private function getSubqueryDescription( &$setNS ) {
@@ -250,6 +251,7 @@ 
 	 * be the content of "[[ ... ]]". Returns NULL upon error.
 	 *
 	 * Parameters $setNS has the same use as in getSubqueryDescription().
+	 * @param boolean $setNS
 	 */
 	private function getLinkDescription( &$setNS ) {
 		// This method is called when we encountered an opening '[['. The following
@@ -433,6 +435,7 @@ 
 	 * a category or property) and create a suitable description.
 	 * The first chunk behind the "[[" has already been read and is
 	 * passed as a parameter.
+	 * @param string $firstChunk
 	 */
 	private function getArticleDescription( $firstChunk, &$setNS ) {
 		$chunk = $firstChunk;
@@ -478,6 +481,10 @@ 
 		return $this->finishLinkDescription( $chunk, true, $result, $setNS );
 	}
 
+	/**
+	 * @param boolean $hasNamespaces
+	 * @param Description|null $result
+	 */
 	private function finishLinkDescription( $chunk, $hasNamespaces, $result, &$setNS ) {
 		if ( is_null( $result ) ) { // no useful information or concrete error found
 			$this->descriptionProcessor->addErrorWithMsgKey( 'smw_unexpectedpart', $chunk ); // was smw_badqueryatom
@@ -574,6 +581,7 @@ 
 	/**
 	 * Enter a new subblock in the query, which must at some time be terminated by the
 	 * given $endstring delimiter calling popDelimiter();
+	 * @param string $endstring
 	 */
 	private function pushDelimiter( $endstring ) {
 		array_push( $this->separatorStack, $endstring );
@@ -583,6 +591,7 @@ 
 	 * Exit a subblock in the query ending with the given delimiter.
 	 * If the delimiter does not match the top-most open block, false
 	 * will be returned. Otherwise return true.
+	 * @param string $endstring
 	 */
 	private function popDelimiter( $endstring ) {
 		$topdelim = array_pop( $this->separatorStack );

includes/queryprinters/CategoryResultPrinter.php

Doc Comments +4 added lines

@@ -224,6 +224,10 @@
 		return ByLanguageCollationMapper::getInstance()->findFirstLetterForCategory( $sortKey );
 	}
 
+	/**
+	 * @param SMWQueryResult $res
+	 * @param boolean $first_col
+	 */
 	private function addRowFieldsToTemplate( $res, $row, &$first_col, $templateRenderer ) {
 
 		// explicitly number parameters for more robust parsing (values may contain "=")

includes/specials/SpecialConcepts.php

Doc Comments +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
 	 * @param integer $from
 	 * @param integer $until
 	 *
-	 * @return DIWikiPage[]
+	 * @return \SMWDIWikiPage[]
 	 */
 	public function getResults( $limit, $from, $until ) {
 		$description = new NamespaceDescription( SMW_NS_CONCEPT );