Docblock improvements for 14.0

[espellcaste]

• Add DocBlocks where missing
• Clarify param/return types where applicable
• Add missing @since versions

Inspired by WordPress Core and something we will have from now on. See ​#60699 No more seeing wrong docblocks and not changing them because there is no related ticket.

Happy to elaborate it further, but a quick read on ​https://wiki.php.net/rfc/void_return_type

and ​https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#1-functions-class-methods might be enough to understand the reason of the incorrect usage.

Trac ticket: ​https://buddypress.trac.wordpress.org/ticket/9164

Trac ticket: ​https://buddypress.trac.wordpress.org/ticket/9164
Trac ticket: ​https://buddypress.trac.wordpress.org/ticket/7228

[espellcaste]

In 13879:

WPCS: miscellaneous fixes for the src/bp-core/admin/bp-core-admin-functions.php template.

See #7224
See #9164

[espellcaste]

In 13880:

WPCS: miscellaneous fixes for the src/bp-core/admin/bp-core-admin-actions.php template.

See #7228
See #9164

[espellcaste]

In 13881:

WPCS: miscellaneous fixes for the src/bp-core/admin/bp-core-admin-components.php template.

See #7228 and #9164

[espellcaste]

In 13882:

PHPDoc: Update incorrect instances of void.

Closes ​https://github.com/buddypress/buddypress/pull/302
See #9164

[espellcaste]

In 13883:

WPCS: miscellaneous fixes for some of the files of the core component.

Closes ​https://github.com/buddypress/buddypress/pull/304
See #9164 and #7228

[espellcaste]

In 13886:

WPCS: Part II: miscellaneous fixes for some of the files of the core component.

Follow-up to ​13883.

See #9164 and #7228

[espellcaste]

In 13887:

WPCS: Part III: miscellaneous fixes for some of the files of the core component.

Follow-up to [13883] and [13886]

See #9164 and #7228

[espellcaste]

In 13888:

WPCS: Part IV: miscellaneous fixes for some of the files of the core component.

Follow-up to [13883], [13886], and [13887]

See #9164 and #7228

[espellcaste]

In 13889:

WPCS: Fix the method signatures for allow_invitation and allow_request.

See #9164 and #7228

[espellcaste]

In 13890:

PHPDoc: remove superfluous comments from boolean returns.

See #9164

[espellcaste]

In 13891:

WPCS: Part V: miscellaneous fixes for some of the files of the core component.

Follow-up to [13883], [13886], [13887], and [13888]

See #9164 and #7228

[espellcaste]

In 13892:

WPCS: Part VI: miscellaneous fixes for some of the files of the core component.

Follow-up to [13883], [13886], [13887], [13888], and [13891]

See #9164 and #7228

[espellcaste]

In 13893:

WPCS: Part VII: miscellaneous fixes for some of the files of the core component.

Follow-up to [13883], [13886], [13887], [13888], [13891], and [13892]

See #9164 and #7228

Trac ticket: ​https://buddypress.trac.wordpress.org/ticket/9164

[espellcaste]

In 13896:

PHPDoc: Correct placement of @since tags.

The @since tag should added before @global, @param, and @return.

Props shailu25
Closes ​https://github.com/buddypress/buddypress/pull/310
See #9164
Fixes #9168

[espellcaste]

Related #8553

[espellcaste]

In 13900:

WPCS: Part VIII: miscellaneous fixes for some of the files of the core component.

Follow-up to [13883], [13886], [13887], [13888], [13891], [13892], [13893]

See #9164 and #7228

[espellcaste]

In 13901:

WPCS: Part IX: miscellaneous fixes for some of the files of the core component.

Follow-up to [13883], [13886], [13887], [13888], [13891], [13892], [13893] and [13900]

See #9164 and #7228

[espellcaste]

In 13903:

WPCS: Part X: miscellaneous fixes for some of the files of the core component.

Follow-up to [13901]

See #9164 and #7228

[espellcaste]

In 13904:

WPCS: Part XI: miscellaneous fixes for some of the files of the core component.

Follow-up to [13903]

See #9164 and #7228

[espellcaste]

Closing for now, any new updates like this can happen in trunk for 15.0. See #9173