From e2ae8f0c4d83060b2606f03b1c86d040c3161f18 Mon Sep 17 00:00:00 2001
From: Harald Eilertsen <haraldei@anduin.net>
Date: Mon, 14 Oct 2024 23:07:42 +0200
Subject: Zotlabs\Lib\DB_Upgrade: Add API documentation.

---
 Zotlabs/Lib/DB_Upgrade.php | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'Zotlabs')

diff --git a/Zotlabs/Lib/DB_Upgrade.php b/Zotlabs/Lib/DB_Upgrade.php
index 7e1016a73..e11c2eb10 100644
--- a/Zotlabs/Lib/DB_Upgrade.php
+++ b/Zotlabs/Lib/DB_Upgrade.php
@@ -1,11 +1,34 @@
 <?php
+/**
+ * A class to handle database schema upgrades.
+ *
+ * SPDX-FileCopyrightText: 2024 Hubzilla Community
+ * SPDX-FileContributor: Harald Eilertsen
+ *
+ * SPDX-License-Identifier: MIT
+ */
 
 namespace Zotlabs\Lib;
 
 use Zotlabs\Lib\Config;
 
+/**
+ * Upgrade the database schema if necessary.
+ *
+ * Compares the currently active database schema version with the version
+ * required for this version of Hubzilla, and performs the upgrade if needed.
+ *
+ * If the difference consists of more than one revision of the schema, each of
+ * the intermediate upgrades are performed in turn.
+ */
 class DB_Upgrade {
 
+	/**
+	 * Check the installed and required schema versions and perform the upgrade
+	 * if necessary.
+	 *
+	 * @param int $db_version	The required DB schema version.
+	 */
 	public static function run(int $db_revision): void {
 
 		$build = Config::Get('system', 'db_version', 0);
-- 
cgit v1.2.3