Skip to content

Improve PHPDoc Consistency Across the Codebase #36

Description

@francescobianco

Summary

While working on the PHPStan static analysis setup, several areas of the codebase were identified where PHPDoc annotations could be improved for better consistency and stronger static analysis support.

In particular, many array parameters, return types, and class properties would benefit from more explicit iterable value type annotations.

Proposed Improvements

  • Add explicit iterable value types for arrays
  • Improve PHPDoc consistency across classes and methods
  • Refine parameter and return type annotations where helpful
  • Reduce ambiguous or missing PHPDoc declarations
  • Improve compatibility with stricter PHPStan analysis levels

Goal

The goal of this issue is to progressively improve the maintainability and static analysis quality of the project while keeping the codebase easier to understand and contribute to.

This work would complement the PHPStan setup introduced in PR #35.

Thanks @Seraphim200001

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions