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

Document code using docstrings #8

Open
Lewiscowles1986 opened this issue Dec 9, 2016 · 1 comment
Open

Document code using docstrings #8

Lewiscowles1986 opened this issue Dec 9, 2016 · 1 comment
Assignees
Milestone

Comments

@Lewiscowles1986
Copy link
Owner

This really needs to have docstrings, minimum explaining class purpose, method signature and internal properties and constants.

@Lewiscowles1986 Lewiscowles1986 added this to the 2.0 milestone Dec 9, 2016
@Lewiscowles1986 Lewiscowles1986 self-assigned this Dec 9, 2016
@peter279k
Copy link
Contributor

peter279k commented Jun 10, 2018

How about using the phpDocumentor to add the doc block comment and organize comment in the source code?

https://github.com/phpDocumentor/phpDocumentor2

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

No branches or pull requests

2 participants