docs: 💡 improve code documentation

[andrewdyer]

This pull request updates and improves code documentation and type annotations across the user management modules and project bootstrap files. The main focus is on clarifying and standardizing PHPDoc comments, improving function signatures, and enhancing overall code readability and maintainability. No functional or behavioral code changes are introduced.

Documentation improvements:

• Standardized and clarified PHPDoc comments for all user-related action classes, DTOs, service, repository, and domain entity files, focusing on concise and accurate method and class descriptions. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21] [22] [23]

• Added or improved file-level docblocks for all bootstrap/*.php files, explaining their purpose and the main function they register. [1] [2] [3] [4] [5]

Type and signature enhancements:

• Added or improved parameter and return type hints for helper functions in app/helpers.php, including root_path, get_env, get_env_array, and require_from_root. [1] [2] [3] [4]

Code style configuration:

• Changed the .php-cs-fixer.dist.php configuration to disable the phpdoc_to_comment rule, ensuring all PHPDoc blocks are preserved as PHPDoc rather than converted to regular comments.

[Copilot]

Pull request overview

This PR focuses on improving PHPDoc documentation and tightening type signatures across the user-management modules and bootstrap/helpers, aiming to make the template easier to understand and maintain without changing runtime behavior.

Changes:

• Standardized/clarified PHPDoc summaries across user actions, DTOs, domain types, repositories, and services.
• Added descriptive docblocks to bootstrap registration files and improved docblocks in tests/factories.
• Strengthened helper function signatures and documentation (e.g., root_path(), get_env(), require_from_root()), and adjusted PHP-CS-Fixer config to preserve PHPDoc.

Reviewed changes

Copilot reviewed 25 out of 25 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tests/Unit/Infrastructure/Persistence/User/InMemoryUserRepositoryTest.php	Adds property/setup docblocks to improve test readability.
tests/Unit/Application/Users/DTOs/CreateUserDTOTest.php	Improves provider docblock and array formatting for clarity.
tests/Support/Factories/UserFactory.php	Refines constructor doc wording for consistency.
tests/Integration/Application/Users/AbstractUsersTestCase.php	Removes redundant @return void from setUp() docblock.
bootstrap/settings.php	Adds a brief docblock describing settings registration.
bootstrap/routes.php	Adds a brief docblock describing route registration.
bootstrap/repositories.php	Adds a brief docblock describing repository bindings.
bootstrap/middleware.php	Adds a brief docblock describing middleware registration.
bootstrap/dependencies.php	Adds a brief docblock describing service dependency registration.
bootstrap/app.php	Adds a brief docblock for app construction and minor formatting.
app/Infrastructure/Persistence/User/InMemoryUserRepository.php	Adjusts repository/method PHPDoc summaries.
app/helpers.php	Adds/clarifies PHPDoc and strengthens parameter/return type declarations.
app/Domain/User/UserRepository.php	Simplifies interface docblock and refines method summary wording.
app/Domain/User/User.php	Simplifies class docblock and refines method summaries.
app/Application/Users/Services/UserService.php	Simplifies class docblock and refines method summaries.
app/Application/Users/DTOs/UserResponseDTO.php	Simplifies class docblock and refines serialization doc.
app/Application/Users/DTOs/UpdateUserDTO.php	Simplifies class docblock and refines constructor doc.
app/Application/Users/DTOs/CreateUserDTO.php	Simplifies class docblock and refines constructor doc.
app/Application/Users/Actions/UpdateUserAction.php	Updates action doc summary to a consistent “Handles …” style.
app/Application/Users/Actions/ShowUserAction.php	Updates action doc summary to a consistent “Handles …” style.
app/Application/Users/Actions/ListUsersAction.php	Updates action doc summary to a consistent “Handles …” style.
app/Application/Users/Actions/DeleteUserAction.php	Updates action doc summary to a consistent “Handles …” style.
app/Application/Users/Actions/CreateUserAction.php	Updates action doc summary to a consistent “Handles …” style.
app/Application/Users/Actions/AbstractUserAction.php	Simplifies base action docblock and constructor summary.
.php-cs-fixer.dist.php	Disables phpdoc_to_comment to keep PHPDoc blocks intact.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 27 out of 27 changed files in this pull request and generated no new comments.