[wp-trac] [WordPress Trac] #30193: Add JSDoc-style options hash descriptions for media class constructors (was: Improve documentation for wp.media.view.MediaFrame.Select)

WordPress Trac noreply at wordpress.org
Thu Oct 30 10:57:33 UTC 2014


#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
------------------------------+-------------------------

Old description:

> Add JSDoc options hash array description.
>
> Move over from @constructor to @class tags, which is the
> [http://usejsdoc.org/tags-class.html preferred nomenclature on the JSDoc
> scene].

New description:

 As we're moving towards JSDoc, let's clean up our options hash
 descriptions in media class constructors.

 This will incldue moving over from @constructor to @class tags, which is
 the [http://usejsdoc.org/tags-class.html preferred nomenclature on the
 JSDoc scene].

--

Comment (by ericlewis):

 In attachment:30193.diff, options hash for media.view.MediaFrame.Select.

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


More information about the wp-trac mailing list