Hi folks, *Just a quick secretary reminder about self-throttling* (two posts/topic/day & avoiding double posting) as this has gained 65 posts in 3 days and this makes topics extremely hard to follow and rather daunting.
*On a technical note* I'd add that we at phpBB use exactly this notation to document individual events, not the methods/functions that contain them. See https://github.com/phpbb/phpbb/blob/master/phpBB/common.php#L161 for an example. We then compile these into documentation on the events in phpBB: https://wiki.phpbb.com/Event_List https://github.com/phpbb/phpbb/blob/master/phpBB/develop/export_events_for_wiki.php Many thanks, Michael On Tuesday, 9 October 2012 07:09:04 UTC+1, Ryan Parman wrote: > > I would like to propose the following enhancement to be included in a > future PHPDoc-specific PSR: @event > > @event > > The @event tag is used to document events that are triggered by this > function or method. > > ## Syntax > > @event <"Type"> <"event_identifier"> [description] > > ## Description > > With the @event tag, it is possible to document and event that is > triggered by the function or method. When provided it MUST contain a "Type" > (See Appendix A) to indicate what is returned; it MUST contain the name > of the event that can be subscribed to by an event handler; the description > on the other hand is OPTIONAL yet RECOMMENDED. > > The @event tag MAY have a multi-line description and does not need > explicit delimiting. > > This tag MAY occur more than once in a "DocBlock" and is limited to the > "DocBlock" of a type method or function. > > ## Examples > > use Symfony\Component\EventDispatcher\Event; > use Vanity\Custom\Event\SimpleEvent; > > /** > * @event Event vanity.task.all.complete Triggers when all of the > tasks have been completed. > * @event SimpleEvent vanity.task.failure Triggers when a task fails > to complete successfully. > */ > > -- You received this message because you are subscribed to the Google Groups "PHP Framework Interoperability Group" group. To unsubscribe from this group and stop receiving emails from it, send an email to php-fig+unsubscr...@googlegroups.com. To post to this group, send email to php-fig@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/php-fig/4a516753-b4e6-4dd4-92ca-fb0ed024a5b4%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
