From 3ce20c20695aeee470e8d36a112b920adf26a984 Mon Sep 17 00:00:00 2001
From: Yasen Pramatarov <yasen@lindeas.com>
Date: Fri, 29 Nov 2024 18:07:47 +0200
Subject: [PATCH] Clean up the PHPDoc comments

---
 app/pages/conferences.php  |  5 +++--
 app/pages/participants.php | 26 +++-----------------------
 app/pages/profile.php      |  9 +--------
 3 files changed, 7 insertions(+), 33 deletions(-)

diff --git a/app/pages/conferences.php b/app/pages/conferences.php
index d84ad54..1c13662 100644
--- a/app/pages/conferences.php
+++ b/app/pages/conferences.php
@@ -3,8 +3,9 @@
 /**
  * Conference information
  *
- * This page ("conferences") handles the listing and searching of conferences from the database.
- * It supports searching by conference ID, name, or listing all conferences within a specified time range.
+ * This page ("conferences") retrieves and displays information about conferences.
+ * Allows filtering by conference ID or name, and listing within a specified time range.
+ * Supports pagination.
  */
 
 require '../app/classes/conference.php';
diff --git a/app/pages/participants.php b/app/pages/participants.php
index 33f3aa2..50fea2a 100644
--- a/app/pages/participants.php
+++ b/app/pages/participants.php
@@ -3,29 +3,9 @@
 /**
  * Participants information
  *
- * This page ("participants") retrieves and displays participant information for conferences,
- * allowing filtering by participant ID, name, or IP address.
- * It supports pagination and displays the results in a widget.
- *
- * Dependencies:
- * - `Participant` class for interacting with the database.
- * - Time range helper for filtering data within a specific time range.
- * - Widget template for displaying results.
- *
- * Global Variables Used:
- * - `$config`: Application configuration array.
- * - `$platformDetails`: Array containing platform details.
- * - `$platform_id`: Current platform ID.
- *
- * Inputs:
- * - `$_REQUEST['id']`: Participant ID to filter by.
- * - `$_REQUEST['name']`: Participant name (stats_id) to filter by.
- * - `$_REQUEST['ip']`: Participant IP to filter by.
- * - `$_REQUEST['p']`: Page number for pagination (default: 1).
- *
- * Outputs:
- * - Displays a widget with the filtered participant data.
- * - Displays an error message if the database connection fails.
+ * This page ("participants") retrieves and displays participant information for conferences.
+ * Allows filtering by participant ID, name, or IP address, and listing within a specified time range.
+ * Supports pagination.
  */
 
 require '../app/classes/participant.php';
diff --git a/app/pages/profile.php b/app/pages/profile.php
index cb7eeac..129cc9d 100644
--- a/app/pages/profile.php
+++ b/app/pages/profile.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * User Profile Management
+ * User profile management
  *
  * This page ("profile") handles user profile actions such as updating user details,
  * avatar management, and assigning or removing user rights.
@@ -10,13 +10,6 @@
  * Actions handled:
  * - `remove`: Remove a user's avatar.
  * - `edit`: Edit user profile details, rights, or avatar.
- *
- * Global Variables Used:
- * - `$userObject`: Instance of the user management class.
- * - `$userDetails`: Current user details array.
- * - `$userRights`: Array of user's current rights.
- * - `$config`: Configuration array for avatars and other settings.
- * - `$app_root`: Base URL of the application.
  */
 
 $action = $_REQUEST['action'] ?? '';