From 9c8a11764d3c674199d61b14770524163adcd941 Mon Sep 17 00:00:00 2001
From: Alexandre Emsenhuber <ialex@users.mediawiki.org>
Date: Thu, 1 Jul 2010 20:45:21 +0000
Subject: [PATCH] Fixed some doxygen warnings

---
 includes/Preferences.php |  4 ++--
 includes/Profiler.php    | 28 +++++++++++++++++-----------
 2 files changed, 19 insertions(+), 13 deletions(-)

diff --git a/includes/Preferences.php b/includes/Preferences.php
index 677593fbbc..87dc83d3cd 100644
--- a/includes/Preferences.php
+++ b/includes/Preferences.php
@@ -996,8 +996,8 @@ class Preferences {
 	}
 
 	/**
-	 * @param object $user The user object
-	 * @return array Text/links to display as key; $skinkey as value
+	 * @param $user The User object
+	 * @return Array: text/links to display as key; $skinkey as value
 	 */
 	static function generateSkinOptions( $user ) {
 		global $wgDefaultSkin, $wgLang, $wgAllowUserCss, $wgAllowUserJs;
diff --git a/includes/Profiler.php b/includes/Profiler.php
index 4c4aa2475f..6deb742e26 100644
--- a/includes/Profiler.php
+++ b/includes/Profiler.php
@@ -12,7 +12,7 @@ $wgProfiling = true;
 
 /**
  * Begin profiling of a function
- * @param $functionname name of the function we will profile
+ * @param $functionname String: name of the function we will profile
  */
 function wfProfileIn( $functionname ) {
 	global $wgProfiler;
@@ -21,7 +21,7 @@ function wfProfileIn( $functionname ) {
 
 /**
  * Stop profiling of a function
- * @param $functionname name of the function we have profiled
+ * @param $functionname String: name of the function we have profiled
  */
 function wfProfileOut( $functionname = 'missing' ) {
 	global $wgProfiler;
@@ -76,7 +76,8 @@ class Profiler {
 
 	/**
 	 * Called by wfProfieIn()
-	 * @param $functionname string
+	 *
+	 * @param $functionname String
 	 */
 	function profileIn( $functionname ) {
 		global $wgDebugFunctionEntry, $wgProfiling;
@@ -90,7 +91,8 @@ class Profiler {
 
 	/**
 	 * Called by wfProfieOut()
-	 * @param $functionname string
+	 *
+	 * @param $functionname String
 	 */
 	function profileOut($functionname) {
 		global $wgDebugFunctionEntry, $wgProfiling;
@@ -142,6 +144,7 @@ class Profiler {
 
 	/**
 	 * Mark this call as templated or not
+	 *
 	 * @param $t Boolean
 	 */
 	function setTemplated( $t ) {
@@ -149,7 +152,7 @@ class Profiler {
 	}
 
 	/**
-	 * called by wfGetProfilingOutput()
+	 * Called by wfGetProfilingOutput()
 	 */
 	function getOutput() {
 		global $wgDebugFunctionEntry, $wgProfileCallTree;
@@ -173,7 +176,7 @@ class Profiler {
 	}
 
 	/**
-	 * returns a tree of function call instead of a list of functions
+	 * Returns a tree of function call instead of a list of functions
 	 */
 	function getCallTree() {
 		return implode( '', array_map( array( &$this, 'getCallTreeLine' ), $this->remapCallTree( $this->mStack ) ) );
@@ -365,9 +368,10 @@ class Profiler {
 	/**
 	 * Log a function into the database.
 	 *
-	 * @param $name string: function name
-	 * @param $timeSum float
-	 * @param $eventCount int: number of times that function was called
+	 * @param $name String: function name
+	 * @param $timeSum Float
+	 * @param $eventCount Integer: number of times that function was called
+	 * @param $memorySum Integer: memory used by the function
 	 */
 	static function logToDB( $name, $timeSum, $eventCount, $memorySum ){
 		# Do not log anything if database is readonly (bug 5375)
@@ -429,7 +433,8 @@ class Profiler {
 
 	/**
 	 * Get function caller
-	 * @param $level int
+	 *
+	 * @param $level Integer
 	 */
 	static function getCaller( $level ) {
 		$backtrace = wfDebugBacktrace();
@@ -447,7 +452,8 @@ class Profiler {
 
 	/**
 	 * Add an entry in the debug log file
-	 * @param $s string to output
+	 *
+	 * @param $s String to output
 	 */
 	function debug( $s ) {
 		if( function_exists( 'wfDebug' ) ) {
-- 
2.20.1