[buddypress-trac] [BuddyPress] #2345: PHP documentation needed through-out BP

[buddypress-trac at lists.automattic.com]

#2345: PHP documentation needed through-out BP
-----------------------------+-----------------------------
 Reporter:  johnjamesjacoby  |       Owner:
     Type:  task             |      Status:  assigned
 Priority:  minor            |   Milestone:  Future Release
Component:  Core             |     Version:
 Severity:  normal           |  Resolution:
 Keywords:  has-patch        |
-----------------------------+-----------------------------

Comment (by boonebgorges):

 I assume that the goal of the @subpackage line is to help programs like
 PHPXref to catalog and organize functions - it's not really meant to
 benefit humans looking directly at the code (who can see both the
 component name and the 'actions' bit by looking at the file tree). For
 that reason, we shouldn't drop the component name, since it will group
 functions from bp-groups-actions.php with those from bp-activity-
 actions.php, etc.

 If anything, I think we should go with just the component name. I'd argue
 that the -actions functions are not really a sub-*package* at all, as they
 don't really stand alone in any meaningful sense.

-- 
Ticket URL: <https://buddypress.trac.wordpress.org/ticket/2345#comment:16>
BuddyPress <http://buddypress.org/>
BuddyPress