Yoast / wordpress-develop-mirror

WordPress development sync to develop patches against.
https://make.wordpress.org/core/
5 stars 3 forks source link

Improve documentation for the media library #62

Open omarreiss opened 7 years ago

omarreiss commented 7 years ago

Below is a list of all files in the media library. The goal is to go through all the files and improve the documentation where possible. After documenting all the separate files, we need to add a readme to the library explaining in more general terms about the technical structure of the media library.

This issue is to keep track of progress in documenting the media library. Any architectural learnings about media can be shared here as well as input for the readme we need to create later.

File Trac # Description
audiovideo.manifest.js ~41602~ #67
grid.manifest.js #
models.manifest.js #
views.manifest.js #
controllers/audio-details.js #
controllers/collection-add.js #
controllers/collection-edit.js #
controllers/cropper.js 42677 #71
controllers/customize-image-cropper.js 43020 #69
controllers/edit-attachment-metadata.js #
controllers/edit-image.js 42680 #87
controllers/embed.js #
controllers/featured-image.js #
controllers/gallery-add.js 43500 #88
controllers/gallery-edit.js #
controllers/image-details.js #
controllers/library.js #
controllers/media-library.js #
controllers/region.js #
controllers/replace-image.js #
controllers/site-icon-cropper.js #
controllers/state-machine.js #
controllers/state.js #
controllers/video-details.js #
models/attachment.js #
models/attachments.js #
models/post-image.js #
models/post-media.js #
models/query.js #
models/selection.js #
routers/manage.js #
utils/selection-sync.js #
views/attachment-compat.js #
views/attachment-filters.js #
views/attachment.js #
views/attachments.js 42955 #76
views/audio-details.js #
views/button-group.js #
views/button.js #
views/cropper.js #
views/edit-image-details.js #
views/edit-image.js #
views/embed.js #
views/focus-manager.js #
views/frame.js #
views/iframe.js #
views/image-details.js #
views/label.js #
views/media-details.js #
views/media-frame.js #
views/menu-item.js #
views/menu.js #
views/modal.js #
views/priority-list.js #
views/router-item.js #
views/router.js #
views/search.js #
views/selection.js #
views/settings.js #
views/sidebar.js #
views/site-icon-cropper.js #
views/site-icon-preview.js #
views/spinner.js #
views/toolbar.js #
views/video-details.js #
views/view.js #
views/attachment-filters/all.js #
views/attachment-filters/date.js #
views/attachment-filters/uploaded.js #
views/attachment/details-two-column.js #
views/attachment/details.js #
views/attachment/edit-library.js #
views/attachment/edit-selection.js #
views/attachment/library.js #
views/attachment/selection.js #
views/attachments/browser.js #
views/attachments/selection.js #
views/button/delete-selected-permanently.js #
views/button/delete-selected.js #
views/button/select-mode-toggle.js #
views/embed/image.js #
views/embed/link.js #
views/embed/url.js #
views/frame/audio-details.js #
views/frame/edit-attachments.js #
views/frame/image-details.js #
views/frame/manage.js #
views/frame/media-details.js #
views/frame/post.js #
views/frame/select.js #
views/frame/video-details.js #
views/settings/attachment-display.js #
views/settings/gallery.js #
views/settings/playlist.js #
views/toolbar/embed.js #
views/toolbar/select.js #
views/uploader/editor.js #
views/uploader/inline.js #
views/uploader/status-error.js #
views/uploader/status.js #
views/uploader/window.js #
Add README.txt #
moorscode commented 6 years ago

To run JSDoc please follow instructions found here: https://github.com/Yoast/wordpress-develop-mirror/wiki/Running-JSDoc-generation