[buddypress-trac] [BuddyPress Trac] #7377: Inline documentation improvements for 2.8

[buddypress-trac]

#7377: Inline documentation improvements for 2.8
-------------------------+------------------
 Reporter:  slaFFik      |       Owner:
     Type:  enhancement  |      Status:  new
 Priority:  low          |   Milestone:  2.8
Component:  Core         |     Version:
 Severity:  minor        |  Resolution:
 Keywords:               |
-------------------------+------------------
Description changed by slaFFik:

Old description:

> There are bunch of places, where PHPDoc is not synced with the related
> doc.
> Example:
>

> {{{
> /**
>  * Render the Group Type metabox.
>  *
>  * @since 2.6.0
>  *
>  * @param BP_Groups_Group|null $user The BP_Groups_Group object
> corresponding to the group being edited.
>  */
> function bp_groups_admin_edit_metabox_group_type( BP_Groups_Group $group
> = null ) {}
> }}}
>
> Note the usage of `$user` in `@param`. This might be a problem later,
> when we will start using https://developer.buddypress.org by @tw2113, so
> it's better to fix earlier.

New description:

 There are bunch of places, where PHPDoc is not synced with the related
 doc.
 Example:


 {{{
 /**
  * Render the Group Type metabox.
  *
  * @since 2.6.0
  *
  * @param BP_Groups_Group|null $user The BP_Groups_Group object
 corresponding to the group being edited.
  */
 function bp_groups_admin_edit_metabox_group_type( BP_Groups_Group $group =
 null ) {}
 }}}

 Note the usage of `$user` in `@param` and `$group` in code. This might be
 a problem later, when we will start using https://developer.buddypress.org
 by @tw2113, so it's better to fix earlier.

 The goal of this task is to make constant improvements in such places in
 various parts of the BuddyPress code.

--

--
Ticket URL: <https://buddypress.trac.wordpress.org/ticket/7377#comment:1>
BuddyPress Trac <http://buddypress.org/>
BuddyPress Trac