[buddypress-trac] [BuddyPress Trac] #6576: @since standard not parseable with phpDocumentor 2

buddypress-trac noreply at wordpress.org
Tue Aug 11 23:38:04 UTC 2015

#6576: @since standard not parseable with phpDocumentor 2
 Reporter:  DJPaul               |       Owner:
     Type:  defect (bug)         |      Status:  new
 Priority:  normal               |   Milestone:  2.4
Component:  Component - Any/All  |     Version:
 Severity:  normal               |  Resolution:
 Keywords:  dev-feedback         |

Comment (by johnjamesjacoby):

 Our bespoke format came from the confluence of a few issues I was having
 at the time:

 * phpDocumentor had no way to differentiate `@since` tags between
 * IDE's weren't able to discern dependency between projects and functions
 * Searching an entire installation for something like `@since 2.0` would
 bring up results for WordPress, BuddyPress, and bbPress, which was a
 frustrating developer experience
 * It was my first real deep dive into exactly what the phpDocumentor spec
 was, and I overlooked exactly how `@since` worked (and did not work)

 How about:

 * `@since 2.7.0 BuddyPress (rxxxx) - Whatever the details are` where the
 (rxxxx) is optional. We've debated the usefulness of including the
 changeset in the past, but I have a tendency to use them in bbPress quite
 a bit for looking back in time very easily without loading up annotations
 every time.
 * `@package BuddyPress` at the top of each file in the PHPDoc block
 * `@subpackage Functions` underneath `@package` where "Functions" is some
 descriptor that works across all components (Actions, Cache, Classes,
 Assets, Filters, Functions, Loader, Notifications, Screens, TemplateTags,
 Widgets, etc...)

Ticket URL: <https://buddypress.trac.wordpress.org/ticket/6576#comment:10>
BuddyPress Trac <http://buddypress.org/>
BuddyPress Trac

More information about the buddypress-trac mailing list