Merge "fix backup unit tests"

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

diff --git a/includes/PoolCounter.php b/includes/PoolCounter.php
index 83ae0ab..452dbc5 100644 (file)
--- a/includes/PoolCounter.php
+++ b/includes/PoolCounter.php
@@ -1,4 +1,25 @@
 <?php
+/**
+ * Provides of semaphore semantics for restricting the number
+ * of workers that may be concurrently performing the same task.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
 
 /**
  *  When you have many workers (threads/servers) giving service, and a
@@ -150,6 +171,7 @@ abstract class PoolCounterWork {
 
        /**
         * Do something with the error, like showing it to the user.
+        * @return bool
         */
        function error( $status ) {
                return false;