http://www.mediawiki.org/wiki/Special:Code/MediaWiki/73860
Revision: 73860
Author: reedy
Date: 2010-09-28 01:33:11 +0000 (Tue, 28 Sep 2010)
Log Message:
-----------
Tweak/add some documentation as hints for some code analysis
Modified Paths:
--------------
trunk/phase3/includes/RecentChange.php
trunk/phase3/includes/api/ApiBase.php
trunk/phase3/includes/api/ApiMain.php
Modified: trunk/phase3/includes/RecentChange.php
===================================================================
--- trunk/phase3/includes/RecentChange.php 2010-09-28 01:21:38 UTC (rev
73859)
+++ trunk/phase3/includes/RecentChange.php 2010-09-28 01:33:11 UTC (rev
73860)
@@ -115,6 +115,10 @@
$this->mExtra = $extra;
}
+ /**
+ *
+ * @return Title
+ */
public function &getTitle() {
if( $this->mTitle === false ) {
$this->mTitle = Title::makeTitle(
$this->mAttribs['rc_namespace'], $this->mAttribs['rc_title'] );
@@ -579,7 +583,7 @@
/**
* Get an attribute value
*
- * @param $name Attribute name
+ * @param $name String Attribute name
* @return mixed
*/
public function getAttribute( $name ) {
Modified: trunk/phase3/includes/api/ApiBase.php
===================================================================
--- trunk/phase3/includes/api/ApiBase.php 2010-09-28 01:21:38 UTC (rev
73859)
+++ trunk/phase3/includes/api/ApiBase.php 2010-09-28 01:33:11 UTC (rev
73860)
@@ -551,7 +551,7 @@
* Return true if we're to watch the page, false if not, null if no
change.
* @param $watchlist String Valid values: 'watch', 'unwatch',
'preferences', 'nochange'
* @param $titleObj Title the page under consideration
- * @param $userOption The user option to consider when
$watchlist=preferences.
+ * @param $userOption String The user option to consider when
$watchlist=preferences.
* If not set will magically default to either watchdefault or
watchcreations
* @returns mixed
*/
Modified: trunk/phase3/includes/api/ApiMain.php
===================================================================
--- trunk/phase3/includes/api/ApiMain.php 2010-09-28 01:21:38 UTC (rev
73859)
+++ trunk/phase3/includes/api/ApiMain.php 2010-09-28 01:33:11 UTC (rev
73860)
@@ -530,7 +530,7 @@
/**
* Set up the module for response
- * @return Object the module that will handle this action
+ * @return ApiBase The module that will handle this action
*/
protected function setupModule() {
// Instantiate the module requested by the user
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
