You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If we can make some kind of snapshot of the docblocks for a function/method at a certain time, we can see which documentation has not been updated when the function is changed.
This would include the following steps:
Edit function with a docblock.
Run php-doc-check
If the functions meet a complexity metric: php-doc-check will compare the current docblock and function (length or complexity) to what is saved in the snapshot.
3.a. If the DocBlock is the same as the one in the snapshot: error that the DocBlock has not been updated.
3.b. If the DocBlock has changed, update the snapshot with the new docblock and filelength.
Manually edit the DocBlocks that have errored where applicable
Goto step 3 until all errors have been removed, or all the docblocks for all remaining errors are still descriptive of the function and origin of the code.
If remaining errors don't require changes: manually regenerate snapshot.
Commit changes and snapshot.
The text was updated successfully, but these errors were encountered:
If we can make some kind of snapshot of the docblocks for a function/method at a certain time, we can see which documentation has not been updated when the function is changed.
This would include the following steps:
3.a. If the DocBlock is the same as the one in the snapshot: error that the DocBlock has not been updated.
3.b. If the DocBlock has changed, update the snapshot with the new docblock and filelength.
The text was updated successfully, but these errors were encountered: