http://www.mediawiki.org/wiki/Special:Code/MediaWiki/89105
Revision: 89105
Author: reedy
Date: 2011-05-29 14:25:20 +0000 (Sun, 29 May 2011)
Log Message:
-----------
And even more documentation in various files
Modified Paths:
--------------
trunk/phase3/includes/Revision.php
trunk/phase3/includes/ZhClient.php
trunk/phase3/includes/objectcache/ObjectCache.php
trunk/phase3/includes/parser/CoreTagHooks.php
trunk/phase3/includes/parser/LinkHolderArray.php
trunk/phase3/includes/search/SearchMySQL.php
trunk/phase3/includes/search/SearchSqlite.php
trunk/phase3/includes/specials/SpecialRecentchanges.php
trunk/phase3/includes/specials/SpecialStatistics.php
trunk/phase3/includes/upload/UploadFromStash.php
trunk/phase3/includes/upload/UploadStash.php
Modified: trunk/phase3/includes/Revision.php
===================================================================
--- trunk/phase3/includes/Revision.php 2011-05-29 14:24:27 UTC (rev 89104)
+++ trunk/phase3/includes/Revision.php 2011-05-29 14:25:20 UTC (rev 89105)
@@ -67,6 +67,9 @@
* for permissions or even inserted (as in Special:Undelete)
* @todo FIXME: Should be a subclass for RevisionDelete. [TS]
*
+ * @param $row
+ * @param $overrides array
+ *
* @return Revision
*/
public static function newFromArchiveRow( $row, $overrides = array() ) {
Modified: trunk/phase3/includes/ZhClient.php
===================================================================
--- trunk/phase3/includes/ZhClient.php 2011-05-29 14:24:27 UTC (rev 89104)
+++ trunk/phase3/includes/ZhClient.php 2011-05-29 14:25:20 UTC (rev 89105)
@@ -9,7 +9,10 @@
/**
* Constructor
*
- * @access private
+ * @param $host
+ * @param $port
+ *
+ * @return ZhClient
*/
function __construct( $host, $port ) {
$this->mHost = $host;
@@ -48,6 +51,8 @@
* Query the daemon and return the result
*
* @access private
+ *
+ * @return string
*/
function query( $request ) {
if ( !$this->mConnected ) {
Modified: trunk/phase3/includes/objectcache/ObjectCache.php
===================================================================
--- trunk/phase3/includes/objectcache/ObjectCache.php 2011-05-29 14:24:27 UTC
(rev 89104)
+++ trunk/phase3/includes/objectcache/ObjectCache.php 2011-05-29 14:25:20 UTC
(rev 89105)
@@ -34,6 +34,10 @@
/**
* Create a new cache object of the specified type.
+ *
+ * @param $id
+ *
+ * @return ObjectCache
*/
static function newFromId( $id ) {
global $wgObjectCaches;
@@ -50,6 +54,8 @@
* Create a new cache object from parameters
*
* @param $params array
+ *
+ * @return ObjectCache
*/
static function newFromParams( $params ) {
if ( isset( $params['factory'] ) ) {
Modified: trunk/phase3/includes/parser/CoreTagHooks.php
===================================================================
--- trunk/phase3/includes/parser/CoreTagHooks.php 2011-05-29 14:24:27 UTC
(rev 89104)
+++ trunk/phase3/includes/parser/CoreTagHooks.php 2011-05-29 14:25:20 UTC
(rev 89105)
@@ -54,7 +54,7 @@
* Uses undocumented extended tag hook return values, introduced in
r61913.
*
* @param $content string
- * @param $attribs array
+ * @param $attributes array
* @param $parser Parser
* @return array
*/
@@ -75,7 +75,7 @@
* Uses undocumented extended tag hook return values, introduced in
r61913.
*
* @param $content string
- * @param $attribs array
+ * @param $attributes array
* @param $parser Parser
* @return array
*/
Modified: trunk/phase3/includes/parser/LinkHolderArray.php
===================================================================
--- trunk/phase3/includes/parser/LinkHolderArray.php 2011-05-29 14:24:27 UTC
(rev 89104)
+++ trunk/phase3/includes/parser/LinkHolderArray.php 2011-05-29 14:25:20 UTC
(rev 89105)
@@ -94,7 +94,7 @@
* strings will be returned.
*
* @param $other LinkHolderArray
- * @param $text Array of strings
+ * @param $texts Array of strings
* @return Array
*/
function mergeForeign( $other, $texts ) {
Modified: trunk/phase3/includes/search/SearchMySQL.php
===================================================================
--- trunk/phase3/includes/search/SearchMySQL.php 2011-05-29 14:24:27 UTC
(rev 89104)
+++ trunk/phase3/includes/search/SearchMySQL.php 2011-05-29 14:25:20 UTC
(rev 89105)
@@ -44,6 +44,9 @@
* Parse the user's query and transform it into an SQL fragment which
will
* become part of a WHERE clause
*
+ * @param $filteredText string
+ * @param $fullText string
+ *
* @return string
*/
function parseQuery( $filteredText, $fulltext ) {
Modified: trunk/phase3/includes/search/SearchSqlite.php
===================================================================
--- trunk/phase3/includes/search/SearchSqlite.php 2011-05-29 14:24:27 UTC
(rev 89104)
+++ trunk/phase3/includes/search/SearchSqlite.php 2011-05-29 14:25:20 UTC
(rev 89105)
@@ -51,6 +51,8 @@
/**
* Parse the user's query and transform it into an SQL fragment which
will
* become part of a WHERE clause
+ *
+ * @return string
*/
function parseQuery( $filteredText, $fulltext ) {
global $wgContLang;
@@ -72,7 +74,9 @@
$quote = '"';
}
- if( $searchon !== '' ) $searchon .= ' ';
+ if( $searchon !== '' ) {
+ $searchon .= ' ';
+ }
// Some languages such as Serbian store the
input form in the search index,
// so we may need to search for matches in
multiple writing system variants.
Modified: trunk/phase3/includes/specials/SpecialRecentchanges.php
===================================================================
--- trunk/phase3/includes/specials/SpecialRecentchanges.php 2011-05-29
14:24:27 UTC (rev 89104)
+++ trunk/phase3/includes/specials/SpecialRecentchanges.php 2011-05-29
14:25:20 UTC (rev 89105)
@@ -66,6 +66,8 @@
/**
* Create a FormOptions object with options as specified by the user
*
+ * @param $parameters array
+ *
* @return FormOptions
*/
public function setup( $parameters ) {
Modified: trunk/phase3/includes/specials/SpecialStatistics.php
===================================================================
--- trunk/phase3/includes/specials/SpecialStatistics.php 2011-05-29
14:24:27 UTC (rev 89104)
+++ trunk/phase3/includes/specials/SpecialStatistics.php 2011-05-29
14:25:20 UTC (rev 89105)
@@ -124,8 +124,7 @@
" ($descriptionText)" );
}
}
- return
- Html::rawElement( 'tr', $trExtraParams,
+ return Html::rawElement( 'tr', $trExtraParams,
Html::rawElement( 'td', array(), $text ) .
Html::rawElement( 'td', array( 'class' =>
'mw-statistics-numbers' ), $number )
);
Modified: trunk/phase3/includes/upload/UploadFromStash.php
===================================================================
--- trunk/phase3/includes/upload/UploadFromStash.php 2011-05-29 14:24:27 UTC
(rev 89104)
+++ trunk/phase3/includes/upload/UploadFromStash.php 2011-05-29 14:25:20 UTC
(rev 89105)
@@ -73,6 +73,8 @@
/**
* File has been previously verified so no need to do so again.
+ *
+ * @return bool
*/
protected function verifyFile() {
return true;
Modified: trunk/phase3/includes/upload/UploadStash.php
===================================================================
--- trunk/phase3/includes/upload/UploadStash.php 2011-05-29 14:24:27 UTC
(rev 89104)
+++ trunk/phase3/includes/upload/UploadStash.php 2011-05-29 14:25:20 UTC
(rev 89105)
@@ -34,6 +34,8 @@
/**
* Represents the session which contains temporarily stored files.
* Designed to be compatible with the session stashing code in
UploadBase (should replace it eventually)
+ *
+ * @param $repo FileRepo
*/
public function __construct( $repo ) {
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
