PHPDoc documentation #47

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.

Sign up for GitHub

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

Jump to bottom

Open

tijmenbruggeman wants to merge 7 commits into tinify:master from wcreateweb:php-docblocks

Contributor

tijmenbruggeman commented Jan 23, 2026

Added documentation for methods and variables using PHPDocblocks.
https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md

Should help static analysers like PHPStan to validate return values/params.

Every method should have a @return value
When refering to something else in the project, use @see

Further improvements:

Generate API documentation
Analyse our own project using PHPStan to confirm correct docs

tijmenbruggeman added 7 commits

January 23, 2026 10:56


          docs: add docs for methods and vars in Tinify class

1d00507


          Document client

7968e07


          Document Source

dee2404


          docs: result and resultmeta

2ac2bd6


          Small improvements

8478ec0


          Docs

9f103aa


          Fix grammar in docs

643493b

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

Labels

None yet