SemanticMediaWiki / SemanticMediaWiki

includes/export/SMW_ExportController.php

Doc Comments +7 added lines, -2 removed lines

@@ -262,6 +262,7 @@ 
 
 	/**
 	 * Add a given SMWDIWikiPage to the export queue if needed.
+	 * @param integer $recursiondepth
 	 */
 	protected function queuePage( SMWDIWikiPage $diWikiPage, $recursiondepth ) {
 		if ( !$this->isPageDone( $diWikiPage, $recursiondepth ) ) {
@@ -273,6 +274,7 @@ 
 	/**
 	 * Mark an article as done while making sure that the cache used for this
 	 * stays reasonably small. Input is given as an SMWDIWikiPage object.
+	 * @param integer $recdepth
 	 */
 	protected function markPageAsDone( SMWDIWikiPage $di, $recdepth ) {
 		$this->markHashAsDone( $di->getHash(), $recdepth );
@@ -281,6 +283,7 @@ 
 	/**
 	 * Mark a task as done while making sure that the cache used for this
 	 * stays reasonably small.
+	 * @param string $hash
 	 */
 	protected function markHashAsDone( $hash, $recdepth ) {
 		if ( count( $this->element_done ) >= self::MAX_CACHE_SIZE ) {
@@ -298,7 +301,6 @@ 
 	/**
 	 * Check if the given object has already been serialised at sufficient
 	 * recursion depth.
-	 * @param SMWDIWikiPage $st specifying the object to check
 	 *
 	 * @return boolean
 	 */
@@ -323,6 +325,7 @@ 
 	 * We make a copy of the object since we may want to add more data later on
 	 * and we do not want to modify the store's result which may be used for
 	 * caching purposes elsewhere.
+	 * @param boolean $core_props_only
 	 */
 	protected function getSemanticData( SMWDIWikiPage $diWikiPage, $core_props_only ) {
 
@@ -489,6 +492,8 @@ 
 
 	/**
 	 * @since 2.0 made protected; use printAllToFile or printAllToOutput
+	 * @param integer $delay
+	 * @param integer $delayeach
 	 */
 	protected function printAll( $ns_restriction = false, $delay, $delayeach ) {
 		$linkCache = LinkCache::singleton();
@@ -730,7 +735,7 @@ 
 	 * requires the namespace to be different from Category, Property, and
 	 * Type; "false" means "no restriction".
 	 *
-	 * @param $res mixed encoding the restriction as described above
+	 * @param boolean $res mixed encoding the restriction as described above
 	 * @param $ns integer the namespace constant to be checked
 	 *
 	 * @return boolean

includes/export/SMW_Serializer.php

Doc Comments +2 added lines, -1 removed lines

@@ -227,6 +227,7 @@ 
 	/**
 	 * State that a certain declaration is needed. The method checks if the
 	 * declaration is already available, and records a todo otherwise.
+	 * @param integer $decltype
 	 */
 	protected function requireDeclaration( SMWExpResource $resource, $decltype ) {
 		// Do not declare predefined OWL language constructs:
@@ -282,7 +283,7 @@ 
 	 * the given element has been declared to has the given type.
 	 *
 	 * @param $element SMWExpResource specifying the element to update
-	 * @param $typeflag integer specifying the type (e.g. SMW_SERIALIZER_DECL_CLASS)
+	 * @param integer $typeflag integer specifying the type (e.g. SMW_SERIALIZER_DECL_CLASS)
 	 */
 	protected function declarationDone( SMWExpResource $element, $typeflag ) {
 		$name = $element->getUri();

includes/export/SMW_Serializer_RDFXML.php

Doc Comments +3 added lines, -3 removed lines

@@ -195,7 +195,7 @@ 
 	 * @param $expResourceProperty SMWExpNsResource the property to use
 	 * @param $expResource SMWExpResource the data value to use
 	 * @param $indent string specifying a prefix for indentation (usually a sequence of tabs)
-	 * @param $isClassTypeProp boolean whether the resource must be declared as a class
+	 * @param boolean $isClassTypeProp boolean whether the resource must be declared as a class
 	 */
 	protected function serializeExpResource( SMWExpNsResource $expResourceProperty, SMWExpResource $expResource, $indent, $isClassTypeProp ) {
 		$this->post_ns_buffer .= $indent . '<' . $expResourceProperty->getQName();
@@ -221,7 +221,7 @@ 
 	 * @param $expResourceProperty SMWExpNsResource the property to use
 	 * @param $expResource array of (SMWExpResource or SMWExpData)
 	 * @param $indent string specifying a prefix for indentation (usually a sequence of tabs)
-	 * @param $isClassTypeProp boolean whether the resource must be declared as a class
+	 * @param boolean $isClassTypeProp boolean whether the resource must be declared as a class
 	 *
 	 * @bug The $isClassTypeProp parameter is not properly taken into account.
 	 * @bug Individual resources are not serialised properly.
@@ -248,7 +248,7 @@ 
 	 * DTD entity declarations in XML. Namely, this require the percent sign
 	 * to be replaced.
 	 *
-	 * @param $string string to be escaped
+	 * @param string $string string to be escaped
 	 * @return string
 	 */
 	protected function makeValueEntityString( $string ) {

includes/export/SMW_Serializer_Turtle.php

Doc Comments +1 added lines, -1 removed lines

@@ -140,7 +140,7 @@
 	 * increased indentation.
 	 *
 	 * @param $data SMWExpData containing the data to be serialised.
-	 * @param $indent string specifying a prefix for indentation (usually a sequence of tabs)
+	 * @param string $indent string specifying a prefix for indentation (usually a sequence of tabs)
 	 */
 	protected function serializeNestedExpData( SMWExpData $data, $indent ) {
 		if ( count( $data->getProperties() ) == 0 ) {

includes/formatters/MessageFormatter.php

Doc Comments +1 added lines, -1 removed lines

@@ -125,6 +125,7 @@ 
 	 *
 	 * @since 1.9
 	 *
+	 * @param string $type
 	 * @return MessageFormatter
 	 */
 	public function setType( $type ) {
@@ -225,7 +226,6 @@ 
 	 *
 	 * @since 1.9
 	 *
-	 * @param boolean $escape
 	 * @param boolean $html
 	 *
 	 * @return string

includes/parserhooks/AskParserFunction.php

Doc Comments +6 added lines, -3 removed lines

@@ -67,6 +67,7 @@ 
 	 *
 	 * @since 1.9
 	 *
+	 * @param boolean $mode
 	 * @return AskParserFunction
 	 */
 	public function setShowMode( $mode ) {
@@ -79,7 +80,7 @@ 
 	 *
 	 * @since 1.9
 	 *
-	 * @return string|null
+	 * @return string
 	 */
 	public function isQueryDisabled() {
 		return $this->messageFormatter->addFromKey( 'smw_iq_disabled' )->getHtml();
@@ -98,9 +99,8 @@ 
 	 *
 	 * @since 1.9
 	 *
-	 * @param array $params
 	 *
-	 * @return string|null
+	 * @return string
 	 */
 	public function parse( array $rawParams ) {
 
@@ -187,6 +187,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param \SMWQuery $query
+	 */
 	private function createQueryProfile( $query, $format, $duration ) {
 
 		// In case of an query error add a marker to the subject for

includes/parserhooks/ShowParserFunction.php

Doc Comments +2 added lines, -3 removed lines

@@ -50,9 +50,8 @@ 
 	 *
 	 * @since 1.9
 	 *
-	 * @param array $params
 	 *
-	 * @return string|null
+	 * @return string
 	 */
 	public function parse( array $rawParams ) {
 
@@ -73,7 +72,7 @@ 
 	 *
 	 * @since 1.9
 	 *
-	 * @return string|null
+	 * @return string
 	 */
 	public function isQueryDisabled() {
 		return $this->messageFormatter->addFromKey( 'smw_iq_disabled' )->getHtml();

includes/parserhooks/SubobjectParserFunction.php

Unused Use Statements -2 removed lines

@@ -2,8 +2,6 @@
 
 namespace SMW;
 
-use Parser;
-
 /**
  * Provides the {{#subobject}} parser function
  *

Doc Comments +8 added lines, -2 removed lines

@@ -84,9 +84,9 @@ 
 	/**
 	 * @since 1.9
 	 *
-	 * @param ParserParameterProcessor $params
+	 * @param ParserParameterProcessor $parameters
 	 *
-	 * @return string|null
+	 * @return string
 	 */
 	public function parse( ParserParameterProcessor $parameters ) {
 
@@ -202,6 +202,9 @@ 
 		return $parameters;
 	}
 
+	/**
+	 * @param \SMWContainerSemanticData $semanticData
+	 */
 	private function doAugmentSortKeyForWhenDisplayTitleIsAccessible( $semanticData ) {
 
 		$sortkey = new DIProperty( DIProperty::TYPE_SORTKEY );
@@ -221,6 +224,9 @@ 
 		);
 	}
 
+	/**
+	 * @param DIWikiPage $subject
+	 */
 	private function addErrorWithMsg( $subject, $errorMsg ) {
 
 		$error = new Error( $subject );

includes/query/SMW_QueryProcessor.php

Doc Comments +3 added lines, -4 removed lines

@@ -165,7 +165,6 @@ 
 	 * @since 1.7
 	 *
 	 * @param array $sortParam
-	 * @param array $orders
 	 * @param string $defaultSort
 	 *
 	 * @return array ( keys => array(), errors => array() )
@@ -473,9 +472,9 @@ 
 	 * printout requests for the query results.
 	 *
 	 * @param string $queryString
-	 * @param array $params These need to be the result of a list fed to getProcessedParams
+	 * @param Param[] $params These need to be the result of a list fed to getProcessedParams
 	 * @param $extraPrintouts
-	 * @param $outputMode
+	 * @param integer $outputMode
 	 * @param $context
 	 *
 	 * @return string
@@ -587,7 +586,7 @@ 
 	 *
 	 * @since 1.6.2, return element type changed in 1.8
 	 *
-	 * @return IParamDefinition[]
+	 * @return ParamProcessor\IParamDefinition[]
 	 */
 	public static function getParameters() {
 		$params = array();