Commit f9c63aba authored by yoshiki@chromium.org's avatar yoshiki@chromium.org

[Cleanup] Files.app: Add '@constructor' annotates to constructors.

All the changes are in comment.

BUG=175657
TEST=none
TBR=mtomasz@chromium.org, haruki@chromium.org

Review URL: https://codereview.chromium.org/12262006

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@182192 0039d316-1c4b-4281-b951-d872f2087c98
parent 7a210e00
...@@ -7,6 +7,7 @@ ...@@ -7,6 +7,7 @@
* Supports undo/redo. * Supports undo/redo.
* Command execution is asynchronous (callback-based). * Command execution is asynchronous (callback-based).
* *
* @constructor
* @param {Document} document Document to create canvases in. * @param {Document} document Document to create canvases in.
* @param {HTMLCanvasElement} canvas The canvas with the original image. * @param {HTMLCanvasElement} canvas The canvas with the original image.
* @param {function(callback)} saveFunction Function to save the image. * @param {function(callback)} saveFunction Function to save the image.
...@@ -217,6 +218,7 @@ CommandQueue.prototype.redo = function() { ...@@ -217,6 +218,7 @@ CommandQueue.prototype.redo = function() {
* Command object encapsulates an operation on an image and a way to visualize * Command object encapsulates an operation on an image and a way to visualize
* its result. * its result.
* *
* @constructor
* @param {string} name Command name. * @param {string} name Command name.
*/ */
function Command(name) { function Command(name) {
......
...@@ -1034,6 +1034,7 @@ ImageEditor.Toolbar.prototype.show = function(on) { ...@@ -1034,6 +1034,7 @@ ImageEditor.Toolbar.prototype.show = function(on) {
/** A prompt panel for the editor. /** A prompt panel for the editor.
* *
* @constructor
* @param {HTMLElement} container Container element. * @param {HTMLElement} container Container element.
* @param {function} displayStringFunction A formatting function. * @param {function} displayStringFunction A formatting function.
*/ */
......
...@@ -156,6 +156,7 @@ ImageEncoder.stringToArrayBuffer = function(string, from, to) { ...@@ -156,6 +156,7 @@ ImageEncoder.stringToArrayBuffer = function(string, from, to) {
* Serves as a default metadata encoder for images that none of the metadata * Serves as a default metadata encoder for images that none of the metadata
* parsers recognized. * parsers recognized.
* *
* @constructor
* @param {Object} original_metadata Starting metadata. * @param {Object} original_metadata Starting metadata.
*/ */
ImageEncoder.MetadataEncoder = function(original_metadata) { ImageEncoder.MetadataEncoder = function(original_metadata) {
......
...@@ -4,6 +4,7 @@ ...@@ -4,6 +4,7 @@
/** /**
* The overlay displaying the image. * The overlay displaying the image.
* @constructor
* @param {HTMLElement} container The container element. * @param {HTMLElement} container The container element.
* @param {Viewport} viewport The viewport. * @param {Viewport} viewport The viewport.
* @param {MetadataCache} metadataCache The metadataCache. * @param {MetadataCache} metadataCache The metadataCache.
...@@ -769,6 +770,7 @@ ImageView.prototype.animateAndReplace = function(canvas, imageCropRect) { ...@@ -769,6 +770,7 @@ ImageView.prototype.animateAndReplace = function(canvas, imageCropRect) {
/** /**
* Generic cache with a limited capacity and LRU eviction. * Generic cache with a limited capacity and LRU eviction.
* *
* @constructor
* @param {number} capacity Maximum number of cached item. * @param {number} capacity Maximum number of cached item.
*/ */
ImageView.Cache = function(capacity) { ImageView.Cache = function(capacity) {
......
...@@ -681,6 +681,7 @@ MediaControls.Slider.prototype.onInputDrag_ = function(on) { ...@@ -681,6 +681,7 @@ MediaControls.Slider.prototype.onInputDrag_ = function(on) {
/** /**
* Create a customized slider with animated thumb movement. * Create a customized slider with animated thumb movement.
* *
* @constructor
* @param {HTMLElement} container The containing div element. * @param {HTMLElement} container The containing div element.
* @param {number} value Initial value [0..1]. * @param {number} value Initial value [0..1].
* @param {number} range Number of distinct slider positions to be supported. * @param {number} range Number of distinct slider positions to be supported.
...@@ -734,6 +735,7 @@ MediaControls.AnimatedSlider.prototype.setValueToUI_ = function(value) { ...@@ -734,6 +735,7 @@ MediaControls.AnimatedSlider.prototype.setValueToUI_ = function(value) {
* *
* The time value is shown above the slider bar at the mouse position. * The time value is shown above the slider bar at the mouse position.
* *
* @constructor
* @param {HTMLElement} container The containing div element. * @param {HTMLElement} container The containing div element.
* @param {number} value Initial value [0..1]. * @param {number} value Initial value [0..1].
* @param {number} range Number of distinct slider positions to be supported. * @param {number} range Number of distinct slider positions to be supported.
......
...@@ -12,6 +12,7 @@ importScripts('../util.js'); ...@@ -12,6 +12,7 @@ importScripts('../util.js');
/** /**
* Dispatches metadata requests to the correct parser. * Dispatches metadata requests to the correct parser.
* *
* @constructor
* @param {Object} port Worker port. * @param {Object} port Worker port.
*/ */
function MetadataDispatcher(port) { function MetadataDispatcher(port) {
......
...@@ -5,6 +5,7 @@ ...@@ -5,6 +5,7 @@
/** /**
* ImportingDialog manages the import process (which is really a copying). * ImportingDialog manages the import process (which is really a copying).
* @constructor
* @param {HTMLElement} parentNode Node to be parent for this dialog. * @param {HTMLElement} parentNode Node to be parent for this dialog.
* @param {FileCopyManager} copyManager Copy manager isntance. * @param {FileCopyManager} copyManager Copy manager isntance.
* @param {MetadataCache} metadataCache Metadata cache. * @param {MetadataCache} metadataCache Metadata cache.
......
...@@ -9,6 +9,7 @@ ...@@ -9,6 +9,7 @@
* Operates on a list of objects representing albums: { name, url, create }. * Operates on a list of objects representing albums: { name, url, create }.
* If user chooses to create a new album, result will be a fake album with * If user chooses to create a new album, result will be a fake album with
* |create == true|. * |create == true|.
* @constructor
* @param {HTMLElement} parentNode Node to be parent for this dialog. * @param {HTMLElement} parentNode Node to be parent for this dialog.
*/ */
function SelectAlbumDialog(parentNode) { function SelectAlbumDialog(parentNode) {
......
...@@ -4,6 +4,7 @@ ...@@ -4,6 +4,7 @@
/** /**
* The album. * The album.
* @constructor
* @param {PhotoSource} source The parent source. * @param {PhotoSource} source The parent source.
* @param {string} name The album name. * @param {string} name The album name.
* @param {Array.<FileEntry>} entries The entries list. * @param {Array.<FileEntry>} entries The entries list.
......
...@@ -449,6 +449,7 @@ TileBox.decorate = function(self, view, entry) { ...@@ -449,6 +449,7 @@ TileBox.decorate = function(self, view, entry) {
/** /**
* Sets box position according to the |rect| property and given sizes. * Sets box position according to the |rect| property and given sizes.
* @constructor
* @param {number} margin Margin between cells. * @param {number} margin Margin between cells.
* @param {number} cellSize The size of one cell. * @param {number} cellSize The size of one cell.
*/ */
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment