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

Improve method phpdoc for CRM_Utils_System #22492

Merged
merged 1 commit into from
Jan 13, 2022

Conversation

braders
Copy link
Contributor

@braders braders commented Jan 12, 2022

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#method

By 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.

@civibot
Copy link

civibot bot commented Jan 12, 2022

(Standard links)

@eileenmcnaughton
Copy link
Contributor

thanks @braders - I agree these typehints really help when using an IDE

@colemanw colemanw merged commit a18a325 into civicrm:master Jan 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants