Improve method phpdoc for CRM_Utils_System #22492
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
The defacto standard for phpdoc comments states that when using
@method
to document static methods the return type must be specified: https://docs.phpdoc.org/guide/references/phpdoc/tags/method.html#methodBy adding the return type void we can ensure that code editors such as VSCode can correctly hint methods against the
CRM_Utils_System
class.Before
Missing return types on
@method
docs.After
Return type
void
added as appropriate. Also a couple of minor formatting tweaks.