[wp-trac] [WordPress Trac] #30193: Add JSDoc-style options hash descriptions for media class constructors

[WordPress Trac]

#30193: Add JSDoc-style options hash descriptions for media class constructors
------------------------------+-------------------------------
 Reporter:  ericlewis         |       Owner:
     Type:  defect (bug)      |      Status:  new
 Priority:  normal            |   Milestone:  4.1
Component:  Media             |     Version:  3.5
 Severity:  normal            |  Resolution:
 Keywords:  has-patch commit  |     Focuses:  javascript, docs
------------------------------+-------------------------------

Comment (by ericlewis):

 In attachment:30193.4.diff (codename Southwest 4570):

 * extended documentation for `media.controller.Region`,
 `media.controller.StateMachine`, `media.selectionSync`, and a bunch of
 other constructors and methods.
 * exhaustive constructor options hash descriptions for
 `media.controller.Library`, `media.controller.ImageDetails`,
 `media.controller.GalleryEdit`, `media.controller.GalleryAdd`,
 `media.controller.CollectionEdit`, `media.controller.CollectionAdd`,
 `media.controller.CollectionAdd`, `media.controller.ReplaceImage`,
 `media.controller.EditImage`, `media.controller.Embed`, and
 `media.view.UploaderWindow`.
 * removed the big blocks like `CONTROLLERS` and `VIEWS`, which aren't
 helpful when this file is 7500 lines long. We're also getting to a point
 where the term "controller" is murky and in cases problematic for
 developer experience. Something gcorne and I spoke about during #wcsf a
 work day: knowing `media.controller.CollectionAdd` is a controller tells
 you nothing about its actual role in the system; knowing it is a state is
 much more helpful.
 * added a few @todos where I found dead or curious code.
 * change all `@constructor`s to `@class`es

--
Ticket URL: <https://core.trac.wordpress.org/ticket/30193#comment:6>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform