Fix return type documentation

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

diff --git a/includes/ProfilerStub.php b/includes/ProfilerStub.php
index abcfb34..e624e6f 100644 (file)
--- a/includes/ProfilerStub.php
+++ b/includes/ProfilerStub.php
@@ -1,24 +1,52 @@
 <?php
+/**
+ * Stub profiling functions
+ * @file
+ * @ingroup Profiler
+ */
 
-# Stub profiling functions
+/** backward compatibility */
+$wgProfiling = false;
+$wgProfiler = null;
+
+/** is setproctitle function available ? */
+$haveProctitle = function_exists( 'setproctitle' );
 
-$haveProctitle=function_exists("setproctitle");
+/**
+ * Begin profiling of a function
+ * @param $fn string
+ */
 function wfProfileIn( $fn = '' ) {
        global $hackwhere, $wgDBname, $haveProctitle;
-       if ($haveProctitle) {
+       if( $haveProctitle ){
                $hackwhere[] = $fn;
-               setproctitle($fn . " [$wgDBname]");
+               setproctitle( $fn . " [$wgDBname]" );
        }
 }
+
+/**
+ * Stop profiling of a function
+ * @param $fn string
+ */
 function wfProfileOut( $fn = '' ) {
        global $hackwhere, $wgDBname, $haveProctitle;
-       if (!$haveProctitle)
+       if( !$haveProctitle ) {
                return;
-       if (count($hackwhere))
-               array_pop($hackwhere);
-       if (count($hackwhere))
-               setproctitle($hackwhere[count($hackwhere)-1] . " [$wgDBname]");
+       }
+       if( count( $hackwhere ) ) {
+               array_pop( $hackwhere );
+       }
+       if( count( $hackwhere ) ) {
+               setproctitle( $hackwhere[count( $hackwhere )-1] . " [$wgDBname]" );
+       }
 }
+
+/**
+ * Does nothing, just for compatibility 
+ */
 function wfGetProfilingOutput( $s, $e ) {}
+
+/**
+ * Does nothing, just for compatibility 
+ */
 function wfProfileClose() {}
-$wgProfiling = false;