SemanticMediaWiki / SemanticMediaWiki

src/Localizer.php

Doc Comments -1 removed lines

@@ -31,7 +31,6 @@
 	 * @since 2.1
 	 *
 	 * @param Language $contentLanguage
-	 * @param Language|null $userLanguage
 	 */
 	public function __construct( Language $contentLanguage) {
 		$this->contentLanguage = $contentLanguage;

src/MediaWiki/Api/PropertyListByApiRequest.php

Doc Comments +5 added lines

@@ -182,6 +182,11 @@
 		return true;
 	}
 
+	/**
+	 * @param string $property
+	 *
+	 * @return string
+	 */
 	private function preprocessPropertyString( $property ) {
 
 		if ( $property{0} !== '_' ) {

includes/datavalues/SMW_DataValue.php

Doc Comments +8 added lines, -7 removed lines

@@ -174,7 +174,7 @@ 
 	 * The third argument was added in SMW 1.9 and should not be used from outside SMW.
 	 *
 	 * @param string $value
-	 * @param mixed $caption
+	 * @param boolean $caption
 	 * @param boolean $approximateValue
 	 */
 	public function setUserValue( $value, $caption = false, $approximateValue = false ) {
@@ -256,7 +256,7 @@ 
 	 *
 	 * @since 1.8
 	 *
-	 * @return SMWDIProperty|null
+	 * @return SMWDIProperty
 	 */
 	public function getProperty() {
 		return $this->m_property;
@@ -278,7 +278,7 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @return DIWikiPage|null
+	 * @return SMWDIWikiPage
 	 */
 	public function getContextPage() {
 		return $this->m_contextPage;
@@ -298,7 +298,7 @@ 
 	 *
 	 * @param string $key
 	 *
-	 * @return mixed|false
+	 * @return string|false
 	 */
 	public function getOptionValueFor( $key ) {
 
@@ -322,7 +322,6 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @param string $caption
 	 */
 	public function getCaption() {
 		return $this->m_caption;
@@ -490,7 +489,7 @@ 
 	 *
 	 * @param string $value
 	 *
-	 * @return Description
+	 * @return SMW\Query\Language\Description
 	 * @throws InvalidArgumentException
 	 */
 	public function getQueryDescription( $value ) {
@@ -511,7 +510,7 @@ 
 	 *
 	 * @since 2.4
 	 *
-	 * @return DataValueFormatter
+	 * @return SMW\DataValues\ValueFormatters\DataValueFormatter
 	 */
 	public function getDataValueFormatter() {
 		return ValueFormatterRegistry::getInstance()->getDataValueFormatterFor( $this );
@@ -585,6 +584,7 @@ 
 	 *
 	 * The parameter $linker controls linking of values such as titles and should
 	 * be some Linker object (or NULL for no linking).
+	 * @return string
 	 */
 	abstract public function getShortHTMLText( $linker = null );
 
@@ -595,6 +595,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 );
 

src/DataValues/MonolingualTextValue.php

Doc Comments +5 added lines, -2 removed lines

@@ -65,7 +65,7 @@ 
 	/**
 	 * @since 2.4
 	 *
-	 * @return integer
+	 * @return boolean
 	 */
 	public function needsLanguageCode() {
 		return ( $this->getOptionValueFor( 'smwgDVFeatures' ) & SMW_DV_MLTV_LCODE ) != 0;
@@ -75,7 +75,6 @@ 
 	 * @see DataValue::parseUserValue
 	 * @note called by DataValue::setUserValue
 	 *
-	 * @param string $value
 	 */
 	protected function parseUserValue( $userValue ) {
 
@@ -245,6 +244,7 @@ 
 	/**
 	 * @since 2.4
 	 *
+	 * @param string $languageCode
 	 * @return DataValue|null
 	 */
 	public function getTextValueByLanguage( $languageCode ) {
@@ -277,6 +277,9 @@ 
 		return $dataValue;
 	}
 
+	/**
+	 * @param string $value
+	 */
 	private function newContainerSemanticData( $value ) {
 
 		if ( $this->m_contextPage === null ) {

src/DataValues/ValueFormatters/MonolingualTextValueFormatter.php

Doc Comments +3 added lines

@@ -119,6 +119,9 @@
 		return $text . $languagecode;
 	}
 
+	/**
+	 * @param DataValue $dataValue
+	 */
 	private function findValueOutputFor( $type, $dataValue, $linker ) {
 		switch ( $type ) {
 			case self::VALUE: return $dataValue->getWikiValue();

includes/GlobalFunctions.php

Doc Comments +1 added lines, -2 removed lines

@@ -95,7 +95,6 @@ 
  * $icon should be one of: 'warning' (default), 'info'.
  *
  * @param array $messages
- * @param string $icon Acts like an enum. Callers must ensure safety, since this value is used directly in the output.
  * @param string $seperator
  * @param boolean $escape Should the messages be escaped or not (ie when they already are)
  *
@@ -201,7 +200,7 @@ 
  * @param mixed $namespace
  * @param boolean $complete
  *
- * @return true
+ * @return boolean
  *
  * @codeCoverageIgnore
  */

src/DataValues/ValueFormatters/StringValueFormatter.php

Doc Comments +3 added lines

@@ -72,6 +72,9 @@
 		return $abbreviate && $length > 255 ? $this->getAbbreviatedText( $text, $length, $linker ) : $text;
 	}
 
+	/**
+	 * @param integer $length
+	 */
 	private function getAbbreviatedText( $text, $length, $linker ) {
 
 		if ( $linker === false || $linker === null ) {

includes/datavalues/SMW_DV_String.php

Doc Comments +3 added lines

@@ -72,6 +72,9 @@
 		return $abbreviate && $length > 255 ? $this->getAbbreviatedText( $text, $length, $linker ) : $text;
 	}
 
+	/**
+	 * @param integer $length
+	 */
 	private function getAbbreviatedText( $text, $length, $linker ) {
 
 		if ( $linker === false || $linker === null ) {

includes/datavalues/SMW_DV_Time.php

Doc Comments +8 added lines, -7 removed lines

@@ -185,14 +185,15 @@ 
 	 * 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
 	 * @return boolean stating if the parsing succeeded
 	 * @todo This method in principle allows date parsing to be internationalized further. Should be done.
 	 */
@@ -402,7 +403,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 ) {