Fixed some doxygen warnings
authorAlexandre Emsenhuber <ialex@users.mediawiki.org>
Sun, 28 Mar 2010 20:21:30 +0000 (20:21 +0000)
committerAlexandre Emsenhuber <ialex@users.mediawiki.org>
Sun, 28 Mar 2010 20:21:30 +0000 (20:21 +0000)
includes/StubObject.php

index c8731ff..c93e3fc 100644 (file)
@@ -21,10 +21,10 @@ class StubObject {
        /**
         * Constructor.
         *
-        * @param String $global name of the global variable.
-        * @param String $class name of the class of the real object.
-        * @param Array $param array of parameters to pass to contructor of the real
-        *                     object.
+        * @param $global String: name of the global variable.
+        * @param $class String: name of the class of the real object.
+        * @param $params Array: parameters to pass to contructor of the real
+        *               object.
         */
        function __construct( $global = null, $class = null, $params = array() ) {
                $this->mGlobal = $global;
@@ -36,8 +36,8 @@ class StubObject {
         * Returns a bool value whetever $obj is a stub object. Can be used to break
         * a infinite loop when unstubbing an object.
         *
-        * @param Object $obj object to check.
-        * @return bool true if $obj is not an instance of StubObject class.
+        * @param $obj Object to check.
+        * @return Boolean: true if $obj is not an instance of StubObject class.
         */
        static function isRealObject( $obj ) {
                return is_object( $obj ) && !($obj instanceof StubObject);
@@ -50,8 +50,8 @@ class StubObject {
         * This function will also call the function with the same name in the real
         * object.
         *
-        * @param String $name name of the function called.
-        * @param Array $args array of arguments.
+        * @param $name String: name of the function called
+        * @param $args Array: arguments
         */
        function _call( $name, $args ) {
                $this->_unstub( $name, 5 );
@@ -69,8 +69,8 @@ class StubObject {
         * Function called by PHP if no function with that name exists in this
         * object.
         *
-        * @param String $name name of the function called
-        * @param Array $args array of arguments
+        * @param $name String: name of the function called
+        * @param $args Array: arguments
         */
        function __call( $name, $args ) {
                return $this->_call( $name, $args );
@@ -82,9 +82,9 @@ class StubObject {
         * This is public, for the convenience of external callers wishing to access
         * properties, e.g. eval.php
         *
-        * @param String $name name of the method called in this object.
-        * @param Integer $level level to go in the stact trace to get the function
-        *                       who called this function.
+        * @param $name String: name of the method called in this object.
+        * @param $level Integer: level to go in the stact trace to get the function
+        *               who called this function.
         */
        function _unstub( $name = '_unstub', $level = 2 ) {
                static $recursionLevel = 0;