Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
blister opened this issue Oct 6, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@blister
Copy link
Contributor

blister commented Oct 6, 2023

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.

@blister blister added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant