From 4f5557f6ca566580abf6cb85632477e898f697db Mon Sep 17 00:00:00 2001
From: Yasen Pramatarov <yasen@lindeas.com>
Date: Wed, 27 Nov 2024 16:26:55 +0200
Subject: [PATCH] Adds phpdoc comments

---
 app/pages/logs.php | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/app/pages/logs.php b/app/pages/logs.php
index a7828f4..002c52e 100644
--- a/app/pages/logs.php
+++ b/app/pages/logs.php
@@ -1,8 +1,11 @@
 <?php
 
-//
-// logs listings
-//
+/**
+ * Logs Listings
+ *
+ * This page ("logs") retrieves and displays logs for a specified user within a time range.
+ * It supports pagination and filtering, and generates a widget to display the logs.
+ */
 
 // specify time range
 include '../app/helpers/time_range.php';
@@ -13,7 +16,7 @@ $browse_page = $_REQUEST['p'] ?? 1;
 $browse_page = (int)$browse_page;
 $offset = ($browse_page -1) * $items_per_page;
 
-// user or system
+// logs scope: user or system
 $scope = 'user';
 
 // prepare the result