#30193 closed defect (bug) (fixed)
Add JSDoc-style options hash descriptions for media class constructors
| Reported by: | ericlewis | Owned by: | |
|---|---|---|---|
| Priority: | normal | Milestone: | 4.1 |
| Component: | Media | Version: | 3.5 |
| Severity: | normal | Keywords: | has-patch |
| Cc: | Focuses: | javascript, docs |
Description (last modified by )
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 preferred nomenclature on the JSDoc scene.
Attachments (4)
Change History (14)
#2
@
12 years ago
- Description modified (diff)
- Summary Improve documentation for wp.media.view.MediaFrame.Select → Add JSDoc-style options hash descriptions for media class constructors
#3
@
12 years ago
In attachment:30193.2.diff, options hash clean-up for media.controller.Library.
#4
@
12 years ago
In attachment:30193.3.diff, media.controller.Region options hash documentation.
#6
@
12 years ago
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, andmedia.view.UploaderWindow. - removed the big blocks like
CONTROLLERSandVIEWS, 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: knowingmedia.controller.CollectionAddis 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
@constructors to@classes
Note:
See TracTickets
for help on using tickets.
![(please configure the [header_logo] section in trac.ini)](/chrome/site/your_project_logo.png)
In attachment:30193.diff, options hash for media.view.MediaFrame.Select.