Added documentation

diff --git a/include/dbm.php b/include/dbm.php
index d588b2f76a31946c5952de0aec817210b1e02569..3f936947d841b742139a2981a5a660ffc4b48b36 100644 (file)
--- a/include/dbm.php
+++ b/include/dbm.php
@@ -1,5 +1,16 @@
 <?php
+/**
+ * @brief This class contain functions for the database management
+ *
+ */
 class dbm {
+       /**
+        * @brief Return a list of database processes
+        *
+        * @return array
+        *      'list' => List of processes, separated in their different states
+        *      'amount' => Number of concurrent database processes
+        */
        public static function processlist() {
                $r = q("SHOW PROCESSLIST");
                $s = array();
@@ -8,14 +19,13 @@ class dbm {
                $states = array();
                foreach ($r AS $process) {
                        $state = trim($process["State"]);
+
+                       // Filter out all idle processes
                        if (!in_array($state, array("", "init", "statistics"))) {
                                ++$states[$state];
                                ++$processes;
                        }
                }
-               // query end
-               // Sending data
-               // updating
 
                $statelist = "";
                foreach ($states AS $state => $usage) {