From: Michael Vogel <icarus@dabo.de>
Date: Mon, 6 Jun 2016 04:29:03 +0000 (+0200)
Subject: Added documentation
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=3d27ebcb341dd2c1ed8613469362937c51727d5e;p=friendica.git

Added documentation
---

diff --git a/include/dbm.php b/include/dbm.php
index d588b2f76a..3f936947d8 100644
--- 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) {