From 964ea083e68310ca7c09ca938219f4146f0ca5b9 Mon Sep 17 00:00:00 2001 From: canyonknight Date: Sun, 23 Sep 2012 15:12:01 -0400 Subject: stats.inc.php: Document all functions using PHPDoc format Signed-off-by: canyonknight Signed-off-by: Lukas Fleischer --- 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"; -- cgit v1.2.3-70-g09d2