From 3cc4984b14262dc0ed437b0c9d8858fe5ac14c0e Mon Sep 17 00:00:00 2001
From: Victor Westerlund <victor@vlw.se>
Date: Sat, 1 Nov 2025 16:27:01 +0100
Subject: [PATCH] docs: replace docs links with comments (#5)

Reviewed-on: https://codeberg.org/vlw/scaffold/pulls/5
---
 src/API/API.php           | 8 +++-----
 src/Database/Database.php | 8 +++-----
 src/Database/Model.php    | 8 +++-----
 src/Helpers/Paginate.php  | 9 ++++-----
 src/Helpers/UUID.php      | 5 -----
 5 files changed, 13 insertions(+), 25 deletions(-)

diff --git a/src/API/API.php b/src/API/API.php
index b9b5f2d..0b650b3 100644
--- a/src/API/API.php
+++ b/src/API/API.php
@@ -1,14 +1,12 @@
 <?php
 
-	/**
-	 * Read the documentation at:
-	 * https://codeberg.org/vlw/scaffold/docs/API/API.md
-	 */
-
 	namespace vlw\Scaffold\API;
 
 	use Reflect\Rules\Ruleset;
 
+	/**
+	 * Wrapper for Reflect API endpoints
+	 */
 	class API {
 		/**
 		 * Create a new API request with automatic request validation
diff --git a/src/Database/Database.php b/src/Database/Database.php
index c9364d5..962a325 100644
--- a/src/Database/Database.php
+++ b/src/Database/Database.php
@@ -1,10 +1,5 @@
 <?php
 
-	/**
-	 * Read the documentation at:
-	 * https://codeberg.org/vlw/scaffold/docs/Database/Database.md
-	 */
-
 	namespace vlw\Scaffold\Database;
 
 	use vlw\MySQL\MySQL;
@@ -13,6 +8,9 @@
 
 	require_once dirname(__DIR__, 1) . "/Helpers/Paginate.php";
 
+	/**
+	 * Wrapper for vlw\MySQL which reads credentials from .env.ini in the project root.
+	 */
 	class Database extends MySQL {
 		public const DATE_FORMAT     = "Y-m-d";
 		public const DATETIME_FORMAT = "Y-m-d H:i:s";
diff --git a/src/Database/Model.php b/src/Database/Model.php
index 55330c0..3a25932 100644
--- a/src/Database/Model.php
+++ b/src/Database/Model.php
@@ -1,16 +1,14 @@
 <?php
 
-	/**
-	 * Read the documentation at:
-	 * https://codeberg.org/vlw/scaffold/docs/Database/Model.md
-	 */
-
 	namespace vlw\Scaffold\Database;
 
 	use vlw\Scaffold\Database\Database;
 
 	require_once "Database.php";
 
+	/**
+	 * Abstract reading, creating, and updating of database entities.
+	 */
 	abstract class Model {
 		const DATE_FORMAT = Database::DATE_FORMAT;
 
diff --git a/src/Helpers/Paginate.php b/src/Helpers/Paginate.php
index 5cb6520..cb108eb 100644
--- a/src/Helpers/Paginate.php
+++ b/src/Helpers/Paginate.php
@@ -1,12 +1,11 @@
 <?php
 
-	/**
-	 * Read the documentation at:
-	 * https://codeberg.org/vlw/scaffold/docs/Database/Paginate.md
-	 */
-
 	namespace vlw\Scaffold\Helpers;
 
+	/**
+	 * Paginate items of any kind. This class is deisgned to work well with
+	 * vlw\MySQL and the Scaffold\Database\Database class.
+	 */
 	class Paginate {
 		public const KEY               = "p";
 		public const DEFAULT_RANGE     = 3;
diff --git a/src/Helpers/UUID.php b/src/Helpers/UUID.php
index 5ebc148..e5a415b 100644
--- a/src/Helpers/UUID.php
+++ b/src/Helpers/UUID.php
@@ -1,10 +1,5 @@
 <?php
 
-	/**
-	 * Read the documentation at:
-	 * https://codeberg.org/vlw/scaffold/docs/Helpers/UUID.md
-	 */
-
 	namespace vlw\Scaffold\Helpers;
 
 	/**