Fixed some doxygen warnings
authorAlexandre Emsenhuber <ialex@users.mediawiki.org>
Sat, 3 Jul 2010 21:09:25 +0000 (21:09 +0000)
committerAlexandre Emsenhuber <ialex@users.mediawiki.org>
Sat, 3 Jul 2010 21:09:25 +0000 (21:09 +0000)
includes/specials/SpecialMovepage.php
includes/specials/SpecialRecentchanges.php
includes/specials/SpecialWatchlist.php

index 13d9d00..030f744 100644 (file)
@@ -103,7 +103,8 @@ class MovePageForm {
 
        /**
         * Show the form
-        * @param mixed $err Error message. May either be a string message name or 
+        *
+        * @param $err Mixed: error message. May either be a string message name or 
         *    array message name and parameters, like the second argument to 
         *    OutputPage::wrapWikiMsg(). 
         */
index 17d81d5..643e79a 100644 (file)
@@ -108,7 +108,7 @@ class SpecialRecentChanges extends SpecialPage {
        /**
         * Main execution point
         *
-        * @param $subpage string
+        * @param $subpage String
         */
        public function execute( $subpage ) {
                global $wgRequest, $wgOut;
@@ -159,7 +159,7 @@ class SpecialRecentChanges extends SpecialPage {
        /**
         * Return an array with a ChangesFeed object and ChannelFeed object
         *
-        * @return array
+        * @return Array
         */
        public function getFeedObject( $feedFormat ){
                $changesFeed = new ChangesFeed( $feedFormat, 'rcfeed' );
@@ -203,7 +203,7 @@ class SpecialRecentChanges extends SpecialPage {
         * update the timestamp
         *
         * @param $feedFormat String
-        * @return string or false
+        * @return String or false
         */
        public function checkLastModified( $feedFormat ) {
                global $wgUseRCPatrol, $wgOut;
@@ -292,7 +292,7 @@ class SpecialRecentChanges extends SpecialPage {
        /**
         * Process the query
         *
-        * @param $conds array
+        * @param $conds Array
         * @param $opts FormOptions
         * @return database result or false (for Recentchangeslinked only)
         */
@@ -371,7 +371,7 @@ class SpecialRecentChanges extends SpecialPage {
        /**
         * Send output to $wgOut, only called if not used feeds
         *
-        * @param $rows array of database rows
+        * @param $rows Array of database rows
         * @param $opts FormOptions
         */
        public function webOutput( $rows, $opts ) {
@@ -507,7 +507,7 @@ class SpecialRecentChanges extends SpecialPage {
         * Get options to be displayed in a form
         *
         * @param $opts FormOptions
-        * @return array
+        * @return Array
         */
        function getExtraOptions( $opts ){
                $extraOpts = array();
@@ -549,7 +549,7 @@ class SpecialRecentChanges extends SpecialPage {
         * Creates the choose namespace selection
         *
         * @param $opts FormOptions
-        * @return string
+        * @return String
         */
        protected function namespaceFilterForm( FormOptions $opts ) {
                $nsSelect = Xml::namespaceSelector( $opts['namespace'], '' );
@@ -562,7 +562,7 @@ class SpecialRecentChanges extends SpecialPage {
         * Create a input to filter changes by categories
         *
         * @param $opts FormOptions
-        * @return array
+        * @return Array
         */
        protected function categoryFilterForm( FormOptions $opts ) {
                list( $label, $input ) = Xml::inputLabelSep( wfMsg('rc_categories'),
@@ -577,7 +577,7 @@ class SpecialRecentChanges extends SpecialPage {
        /**
         * Filter $rows by categories set in $opts
         *
-        * @param $rows array of database rows
+        * @param $rows Array of database rows
         * @param $opts FormOptions
         */
        function filterByCategories( &$rows, FormOptions $opts ) {
@@ -635,9 +635,11 @@ class SpecialRecentChanges extends SpecialPage {
 
        /**
         * Makes change an option link which carries all the other options
-        * @param $title see Title
-        * @param $override
-        * @param $options
+        *
+        * @param $title Title
+        * @param $override Array: options to override
+        * @param $options Array: current options
+        * @param $active Boolean: whether to show the link in bold
         */
        function makeOptionsLink( $title, $override, $options, $active = false ) {
                global $wgUser;
@@ -653,8 +655,9 @@ class SpecialRecentChanges extends SpecialPage {
 
        /**
         * Creates the options panel.
-        * @param $defaults array
-        * @param $nondefaults array
+        *
+        * @param $defaults Array
+        * @param $nondefaults Array
         */
        function optionsPanel( $defaults, $nondefaults ) {
                global $wgLang, $wgUser, $wgRCLinkLimits, $wgRCLinkDays;
index 9474663..33f2644 100644 (file)
@@ -466,8 +466,9 @@ function wlCutoffLinks( $days, $page = 'Watchlist', $options = array() ) {
 /**
  * Count the number of items on a user's watchlist
  *
- * @param $talk Include talk pages
- * @return integer
+ * @param $user User object
+ * @param $talk Boolean: include talk pages
+ * @return Integer
  */
 function wlCountItems( &$user, $talk = true ) {
        $dbr = wfGetDB( DB_SLAVE, 'watchlist' );