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

buddypress-trac noreply at wordpress.org
Mon Dec 5 23:00:45 UTC 2016


#7377: Inline documentation improvements for 2.8
-------------------------+-----------------
 Reporter:  slaFFik      |      Owner:
     Type:  enhancement  |     Status:  new
 Priority:  low          |  Milestone:  2.8
Component:  Core         |    Version:
 Severity:  minor        |   Keywords:
-------------------------+-----------------
 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.

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


More information about the buddypress-trac mailing list