Page MenuHomePhabricator

VisualEditor: Clean up inconsistent documentation of event emissions
Closed, ResolvedPublic

Description

Some events are undocumented (like ve.dm.Surface.prototype.change, which emits multiple events but documents none), most have the event name without quotes, but some have single quotes (ve.dm.Surface.addInsertionAnnotation) or double quotes (ve.ui.Toolbar.prototype.onContextChange). Parameters sometimes are documented and sometimes aren't, there's no clear distinction between "parameters aren't documented" and "there aren't any", and in no case do we document the types and descriptions of event parameters, we only ever document their names.

We probably also don't document events with @Event nearly as often as we should. It's a huge mess.


Version: unspecified
Severity: normal

Details

Reference
bz45872