clockwork icon indicating copy to clipboard operation
clockwork copied to clipboard

phpdoc for integration methods

Open staabm opened this issue 5 years ago • 2 comments

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

  • resolveAsCommand
  • resolveAsQueueJob

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

  • https://phpstan.org/writing-php-code/phpdoc-types#general-arrays
  • https://phpstan.org/writing-php-code/phpdoc-types#array-shapes

staabm avatar May 13 '20 13:05 staabm

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

itsgoingd avatar May 13 '20 19:05 itsgoingd

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

staabm avatar May 23 '20 09:05 staabm