docs: replace docs links with comments

This commit is contained in:
Victor Westerlund 2025-11-01 16:22:48 +01:00
parent e1d3a09966
commit c73f227bdc
Signed by: vlw
GPG key ID: D0AD730E1057DFC6
5 changed files with 13 additions and 25 deletions

View file

@ -1,14 +1,12 @@
<?php <?php
/**
* Read the documentation at:
* https://codeberg.org/vlw/scaffold/docs/API/API.md
*/
namespace vlw\Scaffold\API; namespace vlw\Scaffold\API;
use Reflect\Rules\Ruleset; use Reflect\Rules\Ruleset;
/**
* Wrapper for Reflect API endpoints
*/
class API { class API {
/** /**
* Create a new API request with automatic request validation * Create a new API request with automatic request validation

View file

@ -1,10 +1,5 @@
<?php <?php
/**
* Read the documentation at:
* https://codeberg.org/vlw/scaffold/docs/Database/Database.md
*/
namespace vlw\Scaffold\Database; namespace vlw\Scaffold\Database;
use vlw\MySQL\MySQL; use vlw\MySQL\MySQL;
@ -13,6 +8,9 @@
require_once dirname(__DIR__, 1) . "/Helpers/Paginate.php"; 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 { class Database extends MySQL {
public const DATE_FORMAT = "Y-m-d"; public const DATE_FORMAT = "Y-m-d";
public const DATETIME_FORMAT = "Y-m-d H:i:s"; public const DATETIME_FORMAT = "Y-m-d H:i:s";

View file

@ -1,16 +1,14 @@
<?php <?php
/**
* Read the documentation at:
* https://codeberg.org/vlw/scaffold/docs/Database/Model.md
*/
namespace vlw\Scaffold\Database; namespace vlw\Scaffold\Database;
use vlw\Scaffold\Database\Database; use vlw\Scaffold\Database\Database;
require_once "Database.php"; require_once "Database.php";
/**
* Abstract reading, creating, and updating of database entities.
*/
abstract class Model { abstract class Model {
const DATE_FORMAT = Database::DATE_FORMAT; const DATE_FORMAT = Database::DATE_FORMAT;

View file

@ -1,12 +1,11 @@
<?php <?php
/**
* Read the documentation at:
* https://codeberg.org/vlw/scaffold/docs/Database/Paginate.md
*/
namespace vlw\Scaffold\Helpers; 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 { class Paginate {
public const KEY = "p"; public const KEY = "p";
public const DEFAULT_RANGE = 3; public const DEFAULT_RANGE = 3;

View file

@ -1,10 +1,5 @@
<?php <?php
/**
* Read the documentation at:
* https://codeberg.org/vlw/scaffold/docs/Helpers/UUID.md
*/
namespace vlw\Scaffold\Helpers; namespace vlw\Scaffold\Helpers;
/** /**