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

[Cleanup] Files.app: Fill missing type annotation in @param tag.

This suppresses 'EE:0213: Missing type in @param tag.' errors from closure linter.

All changes are in comment, hence I believe this patch doesn't change any behavior.

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

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

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@182421 0039d316-1c4b-4281-b951-d872f2087c98
parent 2abb538e
...@@ -3,14 +3,14 @@ ...@@ -3,14 +3,14 @@
// found in the LICENSE file. // found in the LICENSE file.
/** /**
* @constructor
* @class FunctionSequence to invoke steps in sequence * @class FunctionSequence to invoke steps in sequence
* *
* @param {string} name //TODO(JSDOC). * @param {string} name //TODO(JSDOC).
* @param steps array of functions to invoke in parallel. * @param {Array.<function>} steps Array of functions to invoke in parallel.
* @param {Object} logger //TODO(JSDOC). * @param {Object} logger //TODO(JSDOC).
* @param callback callback to invoke on success. * @param {function()} callback Callback to invoke on success.
* @param failureCallback callback to invoke on failure. * @param {function(string)} failureCallback Callback to invoke on failure.
* @constructor
*/ */
function FunctionParallel(name, steps, logger, callback, failureCallback) { function FunctionParallel(name, steps, logger, callback, failureCallback) {
// Private variables hidden in closure // Private variables hidden in closure
...@@ -33,8 +33,8 @@ function FunctionParallel(name, steps, logger, callback, failureCallback) { ...@@ -33,8 +33,8 @@ function FunctionParallel(name, steps, logger, callback, failureCallback) {
/** /**
* Error handling function, which fires error callback. * Error handling function, which fires error callback.
* *
* @param {string} err Error message
* @private * @private
* @param err error message.
*/ */
FunctionParallel.prototype.onError_ = function(err) { FunctionParallel.prototype.onError_ = function(err) {
if (!this.failed_) { if (!this.failed_) {
...@@ -47,6 +47,7 @@ FunctionParallel.prototype.onError_ = function(err) { ...@@ -47,6 +47,7 @@ FunctionParallel.prototype.onError_ = function(err) {
* Advances to next step. This method should not be used externally. In external * Advances to next step. This method should not be used externally. In external
* cases should be used nextStep function, which is defined in closure and thus * cases should be used nextStep function, which is defined in closure and thus
* has access to internal variables of functionsequence. * has access to internal variables of functionsequence.
*
* @private * @private
*/ */
FunctionParallel.prototype.nextStep_ = function() { FunctionParallel.prototype.nextStep_ = function() {
......
...@@ -51,8 +51,8 @@ FunctionSequence.prototype.setFailureCallback = function(failureCallback) { ...@@ -51,8 +51,8 @@ FunctionSequence.prototype.setFailureCallback = function(failureCallback) {
* Error handling function, which traces current error step, stops sequence * Error handling function, which traces current error step, stops sequence
* advancing and fires error callback. * advancing and fires error callback.
* *
* @param {string} err Error message
* @private * @private
* @param err error message.
*/ */
FunctionSequence.prototype.onError_ = function(err) { FunctionSequence.prototype.onError_ = function(err) {
this.logger.vlog('Failed step: ' + this.steps_[this.currentStepIdx_].name + this.logger.vlog('Failed step: ' + this.steps_[this.currentStepIdx_].name +
......
...@@ -256,7 +256,7 @@ Id3Parser.prototype.parse = function(file, metadata, callback, onError) { ...@@ -256,7 +256,7 @@ Id3Parser.prototype.parse = function(file, metadata, callback, onError) {
* Reads last 128 bytes of file in bytebuffer, * Reads last 128 bytes of file in bytebuffer,
* which passes further. * which passes further.
* In last 128 bytes should be placed ID3v1 tag if available. * In last 128 bytes should be placed ID3v1 tag if available.
* @param file - file which bytes to read. * @param {File} file File which bytes to read.
*/ */
function readTail(file) { function readTail(file) {
util.readFileBytes(file, file.size - 128, file.size, util.readFileBytes(file, file.size - 128, file.size,
...@@ -265,8 +265,8 @@ Id3Parser.prototype.parse = function(file, metadata, callback, onError) { ...@@ -265,8 +265,8 @@ Id3Parser.prototype.parse = function(file, metadata, callback, onError) {
/** /**
* Attempts to extract ID3v1 tag from 128 bytes long ByteBuffer * Attempts to extract ID3v1 tag from 128 bytes long ByteBuffer
* @param file file which tags are being extracted. * @param {File} file File which tags are being extracted. Could be used
* Could be used for logging purposes. * for logging purposes.
* @param {ByteReader} reader ByteReader of 128 bytes. * @param {ByteReader} reader ByteReader of 128 bytes.
*/ */
function extractId3v1(file, reader) { function extractId3v1(file, reader) {
...@@ -310,8 +310,9 @@ Id3Parser.prototype.parse = function(file, metadata, callback, onError) { ...@@ -310,8 +310,9 @@ Id3Parser.prototype.parse = function(file, metadata, callback, onError) {
/** /**
* Check if passed array of 10 bytes contains ID3 header. * Check if passed array of 10 bytes contains ID3 header.
* @param file to check and continue reading if ID3 metadata found. * @param {File} file File to check and continue reading if ID3
* @param {ByteReader} reader reader to fill with stream bytes. * metadata found
* @param {ByteReader} reader Reader to fill with stream bytes.
*/ */
function checkId3v2(file, reader) { function checkId3v2(file, reader) {
if (reader.readString(3) == 'ID3') { if (reader.readString(3) == 'ID3') {
...@@ -331,8 +332,8 @@ Id3Parser.prototype.parse = function(file, metadata, callback, onError) { ...@@ -331,8 +332,8 @@ Id3Parser.prototype.parse = function(file, metadata, callback, onError) {
/** /**
* Extracts all ID3v2 frames from given bytebuffer. * Extracts all ID3v2 frames from given bytebuffer.
* @param file being parsed. * @param {File} file File being parsed.
* @param {ByteReader} reader to use for metadata extraction. * @param {ByteReader} reader Reader to use for metadata extraction.
*/ */
function extractFrames(file, reader) { function extractFrames(file, reader) {
var id3v2 = metadata.id3v2; var id3v2 = metadata.id3v2;
......
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