Convert many comments to phpdoc style, and document some more functions

[lhc/web/wiklou.git] / includes / SpecialRecentchanges.php

diff --git a/includes/SpecialRecentchanges.php b/includes/SpecialRecentchanges.php
index 1efacda..56e1509 100644 (file)
--- a/includes/SpecialRecentchanges.php
+++ b/includes/SpecialRecentchanges.php
@@ -1,9 +1,19 @@
 <?php
-
+/**
+ *
+ * @package MediaWiki
+ * @subpackage SpecialPage
+ */
+
+/**
+ *
+ */
 require_once( 'Feed.php' );
 
-function wfSpecialRecentchanges( $par )
-{
+/**
+ * Constructor
+ */
+function wfSpecialRecentchanges( $par ) {
        global $wgUser, $wgOut, $wgLang, $wgTitle, $wgMemc, $wgDBname;
        global $wgRequest, $wgSitename, $wgLanguageCode;
        global $wgFeedClasses;
@@ -156,8 +166,10 @@ function wfSpecialRecentchanges( $par )
        }
 }
 
-function rcCountLink( $lim, $d, $page='Recentchanges', $more='' )
-{
+/**
+ *
+ */
+function rcCountLink( $lim, $d, $page='Recentchanges', $more='' ) {
        global $wgUser, $wgLang;
        $sk = $wgUser->getSkin();
        $s = $sk->makeKnownLink( $wgLang->specialPage( $page ),
@@ -166,8 +178,10 @@ function rcCountLink( $lim, $d, $page='Recentchanges', $more='' )
        return $s;
 }
 
-function rcDaysLink( $lim, $d, $page='Recentchanges', $more='' )
-{
+/**
+ *
+ */
+function rcDaysLink( $lim, $d, $page='Recentchanges', $more='' ) {
        global $wgUser, $wgLang;
        $sk = $wgUser->getSkin();
        $s = $sk->makeKnownLink( $wgLang->specialPage( $page ),
@@ -176,9 +190,11 @@ function rcDaysLink( $lim, $d, $page='Recentchanges', $more='' )
        return $s;
 }
 
+/**
+ *
+ */
 function rcDayLimitLinks( $days, $limit, $page='Recentchanges', $more='', $doall = false, $minorLink = '',
-       $botLink = '', $liuLink = '', $patrLink = '' )
-{
+       $botLink = '', $liuLink = '', $patrLink = '' ) {
        if ($more != '') $more .= '&';
        $cl = rcCountLink( 50, $days, $page, $more ) . ' | ' .
          rcCountLink( 100, $days, $page, $more  ) . ' | ' .
@@ -196,9 +212,10 @@ function rcDayLimitLinks( $days, $limit, $page='Recentchanges', $more='', $doall
        return $note;
 }
 
-# Obsolete? Isn't called from anywhere and $mlink isn't defined
-function rcLimitLinks( $page='Recentchanges', $more='', $doall = false )
-{
+/**
+ * Obsolete? Isn't called from anywhere and $mlink isn't defined
+ */
+function rcLimitLinks( $page='Recentchanges', $more='', $doall = false ) {
        if ($more != '') $more .= '&';
        $cl = rcCountLink( 50, 0, $page, $more ) . ' | ' .
          rcCountLink( 100, 0, $page, $more  ) . ' | ' .