SemanticMediaWiki / SemanticMediaWiki

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();