docs: add PHPDoc to 40+ undocumented public methods #38

Open

Charon wants to merge 0 commits from feat/phpdoc-public-methods into dev

Charon commented

2026-03-24 17:03:50 +00:00

Member

Fixes #18

Summary

Added comprehensive class-level and method-level PHPDoc across 33 source files
Boot files (4): register(), boot(), event handlers, menu providers
Form components (7): render() methods on Input, Textarea, Select, Checkbox, Button, Toggle, FormGroup; hasError() on FormGroup
Modal components (20): class docs, mount(), render(), and all key action methods for Dashboard, Console, Databases, Deployments, Profile, Settings, Platform, Honeypot, WorkspaceSwitcher, WpConnectorSettings, PromptManager, ServiceManager, AccountUsage, PlatformUser, Analytics, UsageDashboard, BoostPurchase, AIServices, and all 3 Entitlement components
Models (2): HoneypotHit and Service class-level docs
Service layer (Service/Boot.php): menuPermissions(), canViewMenu(), version()

Test plan

PHPDoc does not change runtime behaviour
composer test passes (docs only)

Fixes #18 ## Summary - Added comprehensive class-level and method-level PHPDoc across 33 source files - Boot files (4): register(), boot(), event handlers, menu providers - Form components (7): render() methods on Input, Textarea, Select, Checkbox, Button, Toggle, FormGroup; hasError() on FormGroup - Modal components (20): class docs, mount(), render(), and all key action methods for Dashboard, Console, Databases, Deployments, Profile, Settings, Platform, Honeypot, WorkspaceSwitcher, WpConnectorSettings, PromptManager, ServiceManager, AccountUsage, PlatformUser, Analytics, UsageDashboard, BoostPurchase, AIServices, and all 3 Entitlement components - Models (2): HoneypotHit and Service class-level docs - Service layer (Service/Boot.php): menuPermissions(), canViewMenu(), version() ## Test plan - [ ] PHPDoc does not change runtime behaviour - [ ] `composer test` passes (docs only)

This branch is already included in the target branch. There is nothing to merge.

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin feat/phpdoc-public-methods:feat/phpdoc-public-methods

git checkout feat/phpdoc-public-methods

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git checkout dev

git merge --no-ff feat/phpdoc-public-methods

git checkout feat/phpdoc-public-methods

git rebase dev

git checkout dev

git merge --ff-only feat/phpdoc-public-methods

git checkout feat/phpdoc-public-methods

git rebase dev

git checkout dev

git merge --no-ff feat/phpdoc-public-methods

git checkout dev

git merge --squash feat/phpdoc-public-methods