Skip to content

Switch all class documentation to use correctly formatted PHPDoc syntax. #4

@blister

Description

@blister

Our code was originally documented in the early years before PHPDoc existed or had wide adoption.

Now that it exists, we should follow those conventions. Both Painfree.php and all the core classes and scripts inside of /includes need to be updated to use PHPDoc syntax and conventions.

Don't go crazy with it though. Just description, @params, and @returns will be enough for most of our use cases.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions