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

---
 app/pages/profile.php | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/app/pages/profile.php b/app/pages/profile.php
index 879cc57..cb7eeac 100644
--- a/app/pages/profile.php
+++ b/app/pages/profile.php
@@ -1,5 +1,24 @@
 <?php
 
+/**
+ * User Profile Management
+ *
+ * This page ("profile") handles user profile actions such as updating user details,
+ * avatar management, and assigning or removing user rights.
+ * It supports both form submissions and displaying profile templates.
+ *
+ * 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'] ?? '';
 
 // if a form is submitted, it's from the edit page