From b94613f0493767ca78128bb86038648b6490e634 Mon Sep 17 00:00:00 2001
From: Yasen Pramatarov <yasen@lindeas.com>
Date: Fri, 29 Nov 2024 18:38:49 +0200
Subject: [PATCH] Cleans up the phpdoc comments

---
 app/classes/config.php      |  3 +++
 app/classes/database.php    |  2 +-
 app/classes/host.php        |  2 +-
 app/classes/log.php         |  2 +-
 app/classes/participant.php |  2 +-
 app/classes/platform.php    |  2 +-
 app/classes/router.php      |  2 +-
 app/classes/server.php      |  3 ++-
 app/classes/user.php        | 10 +++++++++-
 9 files changed, 20 insertions(+), 8 deletions(-)

diff --git a/app/classes/config.php b/app/classes/config.php
index bcbf847..5eaa3c5 100644
--- a/app/classes/config.php
+++ b/app/classes/config.php
@@ -12,6 +12,7 @@ class Config {
      *
      * @param array $updatedConfig Key-value pairs of configuration options to update.
      * @param string $config_file Path to the configuration file.
+     *
      * @return mixed Returns true on success, or an error message on failure.
      */
     public function editConfigFile($updatedConfig, $config_file) {
@@ -55,6 +56,7 @@ class Config {
      *
      * @param string $jitsiUrl The base URL of the Jitsi server.
      * @param bool $raw Whether to return the full file (true) or only uncommented values (false).
+     *
      * @return string The content of the config.js file or an error message.
      */
     public function getPlatformConfigjs($jitsiUrl, $raw = false) {
@@ -103,6 +105,7 @@ class Config {
      *
      * @param string $jitsiUrl The base URL of the Jitsi server.
      * @param bool $raw Whether to return the full file (true) or only uncommented values (false).
+     *
      * @return string The content of the interface_config.js file or an error message.
      */
     public function getPlatformInterfaceConfigjs($jitsiUrl, $raw = false) {
diff --git a/app/classes/database.php b/app/classes/database.php
index 1c0e314..a8f3355 100644
--- a/app/classes/database.php
+++ b/app/classes/database.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Class Database
+ * class Database
  *
  * Manages database connections for SQLite and MySQL (or MariaDB).
  */
diff --git a/app/classes/host.php b/app/classes/host.php
index c8848a3..32d3b34 100644
--- a/app/classes/host.php
+++ b/app/classes/host.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Class Host
+ * class Host
  *
  * Manages the hosts in the database, providing methods to retrieve, add, edit, and delete host entries.
  */
diff --git a/app/classes/log.php b/app/classes/log.php
index bb5fb2a..c4a1859 100644
--- a/app/classes/log.php
+++ b/app/classes/log.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Class Log
+ * class Log
  *
  * Handles logging events into a database and reading log entries.
  */
diff --git a/app/classes/participant.php b/app/classes/participant.php
index 8293a5d..2043819 100644
--- a/app/classes/participant.php
+++ b/app/classes/participant.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Class Participant
+ * class Participant
  *
  * This class provides methods to retrieve information about participants and their related conference data.
  * It supports querying participant details by ID, name, or IP, as well as listing all participants and counting them within a specific time frame.
diff --git a/app/classes/platform.php b/app/classes/platform.php
index a4bcd47..fe5e60c 100644
--- a/app/classes/platform.php
+++ b/app/classes/platform.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Class Platform
+ * class Platform
  *
  * Handles platform management in the database, including retrieving, adding, editing, and deleting platforms.
  */
diff --git a/app/classes/router.php b/app/classes/router.php
index f398f87..eb3ae62 100644
--- a/app/classes/router.php
+++ b/app/classes/router.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Class Router
+ * class Router
  *
  * A simple Router class to manage URL-to-callback mapping and dispatch requests to the appropriate controllers and methods.
  * The class supports defining routes, matching URLs against patterns, and invoking callbacks for matched routes.
diff --git a/app/classes/server.php b/app/classes/server.php
index eb958a6..b33c589 100644
--- a/app/classes/server.php
+++ b/app/classes/server.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Class Server
+ * class Server
  *
  * Handles server-related operations, including retrieving server status.
  */
@@ -26,6 +26,7 @@ class Server {
      * @param string $host The server hostname or IP address (default: '127.0.0.1').
      * @param int $port The port on which the server is running (default: 8080).
      * @param string $endpoint The health check endpoint path (default: '/health').
+     *
      * @return bool True if the server returns a 200 OK status, otherwise false.
      */
     public function getServerStatus($host = '127.0.0.1', $port = 8080, $endpoint = '/health') {
diff --git a/app/classes/user.php b/app/classes/user.php
index 270298e..b12d7f8 100644
--- a/app/classes/user.php
+++ b/app/classes/user.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Class User
+ * class User
  *
  * Handles user-related functionalities such as registration, login, rights management, and profile updates.
  */
@@ -25,6 +25,7 @@ class User {
      *
      * @param string $username The username of the new user.
      * @param string $password The password for the new user.
+     *
      * @return bool|string True if registration is successful, error message otherwise.
      */
     public function register($username, $password) {
@@ -80,6 +81,7 @@ class User {
      *
      * @param string $username The username of the user.
      * @param string $password The password of the user.
+     *
      * @return bool True if login is successful, false otherwise.
      */
     public function login($username, $password) {
@@ -101,6 +103,7 @@ class User {
      * Retrieves a user ID based on the username.
      *
      * @param string $username The username to look up.
+     *
      * @return array|null User ID details or null if not found.
      */
     // FIXME not used now?
@@ -119,6 +122,7 @@ class User {
      * Fetches user details by user ID.
      *
      * @param int $user_id The user ID.
+     *
      * @return array|null User details or null if not found.
      */
     public function getUserDetails($user_id) {
@@ -146,6 +150,7 @@ class User {
      *
      * @param int $user_id The user ID.
      * @param int $right_id The right ID to grant.
+     *
      * @return void
      */
     public function addUserRight($user_id, $right_id) {
@@ -165,6 +170,7 @@ class User {
      *
      * @param int $user_id The user ID.
      * @param int $right_id The right ID to revoke.
+     *
      * @return void
      */
     public function removeUserRight($user_id, $right_id) {
@@ -202,6 +208,7 @@ class User {
      * Retrieves the rights assigned to a specific user.
      *
      * @param int $user_id The user ID.
+     *
      * @return array List of user rights.
      */
     public function getUserRights($user_id) {
@@ -264,6 +271,7 @@ class User {
      *
      * @param int $user_id The user ID.
      * @param string $right_name The human-readable name of the user right.
+     *
      * @return bool True if the user has the right, false otherwise.
      */
     function hasRight($user_id, $right_name) {