itsgoingd / clockwork

Clockwork - php dev tools in your browser - server-side component
https://underground.works/clockwork
MIT License
5.71k stars 320 forks source link

phpdoc for integration methods #394

Open staabm opened 4 years ago

staabm commented 4 years ago

would be great to have phpdocs for the most used methods which are required for integration with the host applications, e.g.

at best we could have psalm or phpstan like phpdocs, which are pretty precise about the contents of the arrays involved see e.g.

itsgoingd commented 4 years ago

yeah, i can see how writing the integration might be challenging since the clockwork internals are not very well documented

not sure i want to commit to phpdoc tho, i like to keep the comments simple, might add api docs to the website instead

staabm commented 4 years ago

not sure i want to commit to phpdoc tho, i like to keep the comments simple, might add api docs to the website instead

having only the types defined in the php sources (without further full-text description) would already be enough, as our static analysis jobs (and IDE) would do the rest