doc comments: fix grammar and return parameter. fu r77296
authorAntoine Musso <hashar@users.mediawiki.org>
Fri, 26 Nov 2010 07:45:12 +0000 (07:45 +0000)
committerAntoine Musso <hashar@users.mediawiki.org>
Fri, 26 Nov 2010 07:45:12 +0000 (07:45 +0000)
includes/BagOStuff.php

index 5ef9472..d2badc0 100644 (file)
@@ -131,7 +131,9 @@ abstract class BagOStuff {
        }
 
        /**
-        * @return null if lock is not possible. New value incremented by 1 
+        * @param $key String: Key yo increase
+        * @param $value Integer: Value to add to $key (Default 1)
+        * @return null if lock is not possible else $key value increased by $value
         */
        public function incr( $key, $value = 1 ) {
                if ( !$this->lock( $key ) ) {