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

Remove empty param declarations in docblocks #25252

Merged
merged 1 commit into from
Jan 2, 2023

Conversation

braders
Copy link
Contributor

@braders braders commented Jan 1, 2023

Overview

Get's rid of cases where @param is used incorrectly on it's own, with functions that don't take arguments.

Also returns an unused argument $action from getTotalCount, and fixes the documented return type on getMailing.

@civibot
Copy link

civibot bot commented Jan 1, 2023

(Standard links)

@civibot civibot bot added the master label Jan 1, 2023
@@ -286,8 +284,6 @@ public function edit($id, $action) {
/**
* Browse all uf data groups.
*
* @param
*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one does have a param, but it looks like it's always overridden by the local param with the same name.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, it's called without a param on line 170, so I'll remove the $action = NULL.

@braders braders force-pushed the empty-param-annotations branch from 497f671 to 78967f4 Compare January 2, 2023 19:44
@seamuslee001 seamuslee001 merged commit 6b0267f into civicrm:master Jan 2, 2023
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