[aur-dev] [PATCH] stats.inc.php: Document all functions using PHPDoc format

[canyonknight]

Signed-off-by: canyonknight <canyonknight at gmail.com>
---
 web/lib/stats.inc.php | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/web/lib/stats.inc.php b/web/lib/stats.inc.php
index 2c26d43..60973e9 100644
--- a/web/lib/stats.inc.php
+++ b/web/lib/stats.inc.php
@@ -2,6 +2,13 @@
 
 include_once('aur.inc.php');
 
+/**
+ * Display the most recent 10 packages
+ *
+ * @param \PDO $dbh An already established database connection
+ *
+ * @return void
+ */
 function updates_table($dbh) {
 	$key = 'recent_updates';
 	if(!($newest_packages = get_cache_value($key))) {
@@ -17,6 +24,14 @@ function updates_table($dbh) {
 	include('stats/updates_table.php');
 }
 
+/**
+ * Display a user's statistics table
+ *
+ * @param string $userid The user ID of the person to get package statistics for
+ * @param \PDO $dbh An already established database connection
+ *
+ * @return void
+ */
 function user_table($userid, $dbh) {
 	$base_q = "SELECT count(*) FROM Packages WHERE Packages.MaintainerUID = " . $userid;
 
@@ -34,6 +49,13 @@ function user_table($userid, $dbh) {
 	include('stats/user_table.php');
 }
 
+/**
+ * Display the general package statistics table
+ *
+ * @param \PDO $dbh An already established database connection
+ *
+ * @return void
+ */
 function general_stats_table($dbh) {
 	# AUR statistics
 	$q = "SELECT count(*) FROM Packages";
-- 
1.7.12.1