Files.app: Add missing JSdoc for member methods/variables #2.

No semantics are changed.

BUG=175657
TEST=Files.app launches.
TBR=mtomasz@chromium.org

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

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@182246 0039d316-1c4b-4281-b951-d872f2087c98

chrome/browser/resources/file_manager/js/metadata/byte_reader.js

@@ -13,12 +13,37 @@ function ByteReader(arrayBuffer, opt_offset, opt_length) {
 
 // Static const and methods.
 
-ByteReader.LITTLE_ENDIAN = 0;  // Intel, 0x1234 is [0x34, 0x12]
-ByteReader.BIG_ENDIAN = 1;  // Motorola, 0x1234 is [0x12, 0x34]
+/**
+ * Intel, 0x1234 is [0x34, 0x12]
+ * @const
+ * @type {number}
+ */
+ByteReader.LITTLE_ENDIAN = 0;
+/**
+ * Motorola, 0x1234 is [0x12, 0x34]
+ * @const
+ * @type {number}
+ */
+ByteReader.BIG_ENDIAN = 1;
 
-ByteReader.SEEK_BEG = 0;  // Seek relative to the beginning of the buffer.
-ByteReader.SEEK_CUR = 1;  // Seek relative to the current position.
-ByteReader.SEEK_END = 2;  // Seek relative to the end of the buffer.
+/**
+ * Seek relative to the beginning of the buffer.
+ * @const
+ * @type {number}
+ */
+ByteReader.SEEK_BEG = 0;
+/**
+ * Seek relative to the current position.
+ * @const
+ * @type {number}
+ */
+ByteReader.SEEK_CUR = 1;
+/**
+ * Seek relative to the end of the buffer.
+ * @const
+ * @type {number}
+ */
+ByteReader.SEEK_END = 2;
 
 /**
  * Throw an error if (0 > pos >= end) or if (pos + size > end).
@@ -99,6 +124,11 @@ ByteReader.readNullTerminatedStringUTF16 = function(
   return String.fromCharCode.apply(null, codes);
 };
 
+/**
+ * @const
+ * @type {Array.<string>}
+ * @private
+ */
 ByteReader.base64Alphabet_ =
     ('ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/').
     split('');
@@ -225,6 +255,12 @@ ByteReader.prototype.validateRead = function(size, opt_end) {
   ByteReader.validateRead(this.view_, this.pos_, size, opt_end);
 };
 
+/**
+ * @param {number} width  //TODO(JSDOC).
+ * @param {boolean=} opt_signed  //TODO(JSDOC).
+ * @param {number=} opt_end  //TODO(JSDOC).
+ * @return {string}  //TODO(JSDOC).
+ */
 ByteReader.prototype.readScalar = function(width, opt_signed, opt_end) {
   var method = opt_signed ? 'getInt' : 'getUint';
 

chrome/browser/resources/file_manager/js/metadata/exif_parser.js

@@ -28,10 +28,24 @@ function ExifParser(parent) {
 
 ExifParser.prototype = {__proto__: ImageParser.prototype};
 
+/**
+ * @param {File} file  //TODO(JSDOC).
+ * @param {Object} metadata  //TODO(JSDOC).
+ * @param {function} callback  //TODO(JSDOC).
+ * @param {function} errorCallback  //TODO(JSDOC).
+ */
 ExifParser.prototype.parse = function(file, metadata, callback, errorCallback) {
   this.requestSlice(file, callback, errorCallback, metadata, 0);
 };
 
+/**
+ * @param {File} file  //TODO(JSDOC).
+ * @param {function} callback  //TODO(JSDOC).
+ * @param {function} errorCallback  //TODO(JSDOC).
+ * @param {Object} metadata  //TODO(JSDOC).
+ * @param {number} filePos  //TODO(JSDOC).
+ * @param {number=} opt_length  //TODO(JSDOC).
+ */
 ExifParser.prototype.requestSlice = function(
     file, callback, errorCallback, metadata, filePos, opt_length) {
   // Read at least 1Kb so that we do not issue too many read requests.
@@ -46,6 +60,14 @@ ExifParser.prototype.requestSlice = function(
   reader.readAsArrayBuffer(file.slice(filePos, filePos + opt_length));
 };
 
+/**
+ * @param {File} file  //TODO(JSDOC).
+ * @param {function} callback  //TODO(JSDOC).
+ * @param {function} errorCallback  //TODO(JSDOC).
+ * @param {Object} metadata  //TODO(JSDOC).
+ * @param {number} filePos  //TODO(JSDOC).
+ * @param {ArrayBuffer} buf  //TODO(JSDOC).
+ */
 ExifParser.prototype.parseSlice = function(
     file, callback, errorCallback, metadata, filePos, buf) {
   try {
@@ -112,6 +134,11 @@ ExifParser.prototype.parseSlice = function(
   }
 };
 
+/**
+ * @private
+ * @param {number} mark  //TODO(JSDOC).
+ * @return {boolean}  //TODO(JSDOC).
+ */
 ExifParser.isSOF_ = function(mark) {
   // There are 13 variants of SOF fragment format distinguished by the last
   // hex digit of the mark, but the part we want is always the same.
@@ -122,6 +149,11 @@ ExifParser.isSOF_ = function(mark) {
   return (type != 4 && type != 8 && type != 12);
 };
 
+/**
+ * @param {Object} metadata  //TODO(JSDOC).
+ * @param {ArrayBuffer} buf  //TODO(JSDOC).
+ * @param {ByteReader} br  //TODO(JSDOC).
+ */
 ExifParser.prototype.parseExifSection = function(metadata, buf, br) {
   var magic = br.readString(6);
   if (magic != 'Exif\0\0') {
@@ -205,6 +237,11 @@ ExifParser.prototype.parseExifSection = function(metadata, buf, br) {
   }
 };
 
+/**
+ * @param {Object} metadata  //TODO(JSDOC).
+ * @param {number} width  //TODO(JSDOC).
+ * @param {number} height  //TODO(JSDOC).
+ */
 ExifParser.setImageSize = function(metadata, width, height) {
   if (metadata.imageTransform && metadata.imageTransform.rotate90) {
     metadata.width = height;
@@ -215,15 +252,28 @@ ExifParser.setImageSize = function(metadata, width, height) {
   }
 };
 
+/**
+ * @param {ByteReader} br  //TODO(JSDOC).
+ * @return {number}  //TODO(JSDOC).
+ */
 ExifParser.prototype.readMark = function(br) {
   return br.readScalar(2);
 };
 
+/**
+ * @param {ByteReader} br  //TODO(JSDOC).
+ * @return {number}  //TODO(JSDOC).
+ */
 ExifParser.prototype.readMarkLength = function(br) {
   // Length includes the 2 bytes used to store the length.
   return br.readScalar(2) - 2;
 };
 
+/**
+ * @param {ByteReader} br  //TODO(JSDOC).
+ * @param {Array.<Object>} tags  //TODO(JSDOC).
+ * @return {number}  //TODO(JSDOC).
+ */
 ExifParser.prototype.readDirectory = function(br, tags) {
   var entryCount = br.readScalar(2);
   for (var i = 0; i < entryCount; i++) {
@@ -237,6 +287,10 @@ ExifParser.prototype.readDirectory = function(br, tags) {
   return br.readScalar(4);
 };
 
+/**
+ * @param {ByteReader} br  //TODO(JSDOC).
+ * @param {Object} tag  //TODO(JSDOC).
+ */
 ExifParser.prototype.readTagValue = function(br, tag) {
   var self = this;
 
@@ -340,13 +394,25 @@ ExifParser.prototype.readTagValue = function(br, tag) {
             tag.value);
 };
 
-//TODO(JSDOC)
+/**
+ * TODO(JSDOC)
+ * @const
+ * @type {Array.<number>}
+ */
 ExifParser.SCALEX = [1, -1, -1, 1, 1, 1, -1, -1];
 
-//TODO(JSDOC)
+/**
+ * TODO(JSDOC)
+ * @const
+ * @type {Array.<number>}
+ */
 ExifParser.SCALEY = [1, 1, -1, -1, -1, 1, 1, -1];
 
-//TODO(JSDOC)
+/**
+ * TODO(JSDOC)
+ * @const
+ * @type {Array.<number>}
+ */
 ExifParser.ROTATE90 = [0, 0, 0, 0, 1, 1, 1, 1];
 
 /**

chrome/browser/resources/file_manager/js/metadata/id3_parser.js

@@ -124,6 +124,10 @@ Id3Parser.prototype.readUserDefinedTextFrame_ = function(reader,
 
 /**
  * @private
+ * @param {ByteReader} reader Reader to use.
+ * @param {number} majorVersion Major id3 version to use.
+ * @param {Object} frame Frame so store data at.
+ * @param {number} end Frame end position in reader.
  */
 Id3Parser.prototype.readPIC_ = function(reader, majorVersion, frame, end) {
   frame.encoding = reader.readScalar(1, false, end);
@@ -143,6 +147,10 @@ Id3Parser.prototype.readPIC_ = function(reader, majorVersion, frame, end) {
 
 /**
  * @private
+ * @param {ByteReader} reader Reader to use.
+ * @param {number} majorVersion Major id3 version to use.
+ * @param {Object} frame Frame so store data at.
+ * @param {number} end Frame end position in reader.
  */
 Id3Parser.prototype.readAPIC_ = function(reader, majorVersion, frame, end) {
   this.vlog('Extracting picture');
@@ -227,6 +235,12 @@ Id3Parser.prototype.readFrame_ = function(reader, majorVersion) {
   return frame;
 };
 
+/**
+ * @param {File} file  //TODO(JSDOC).
+ * @param {Object} metadata  //TODO(JSDOC).
+ * @param {function(Object)} callback  //TODO(JSDOC).
+ * @param {function(etring)} onError  //TODO(JSDOC).
+ */
 Id3Parser.prototype.parse = function(file, metadata, callback, onError) {
   var self = this;
 

chrome/browser/resources/file_manager/js/metadata/image_parsers.js

@@ -11,6 +11,12 @@ function SimpleImageParser(parent, type, urlFilter, headerSize) {
 
 SimpleImageParser.prototype = {__proto__: ImageParser.prototype};
 
+/**
+ * @param {File} file  //TODO(JSDOC).
+ * @param {Object} metadata  //TODO(JSDOC).
+ * @param {function(Object)} callback  //TODO(JSDOC).
+ * @param {function(string)} errorCallback  //TODO(JSDOC).
+ */
 SimpleImageParser.prototype.parse = function(
     file, metadata, callback, errorCallback) {
   var self = this;
@@ -33,6 +39,10 @@ function PngParser(parent) {
 
 PngParser.prototype = {__proto__: SimpleImageParser.prototype};
 
+/**
+ * @param {Object} metadata  //TODO(JSDOC).
+ * @param {ByteReader} br  //TODO(JSDOC).
+ */
 PngParser.prototype.parseHeader = function(metadata, br) {
   br.setByteOrder(ByteReader.BIG_ENDIAN);
 
@@ -58,6 +68,10 @@ function BmpParser(parent) {
 
 BmpParser.prototype = {__proto__: SimpleImageParser.prototype};
 
+/**
+ * @param {Object} metadata  //TODO(JSDOC).
+ * @param {ByteReader} br  //TODO(JSDOC).
+ */
 BmpParser.prototype.parseHeader = function(metadata, br) {
   br.setByteOrder(ByteReader.LITTLE_ENDIAN);
 
@@ -79,6 +93,10 @@ function GifParser(parent) {
 
 GifParser.prototype = {__proto__: SimpleImageParser.prototype};
 
+/**
+ * @param {Object} metadata  //TODO(JSDOC).
+ * @param {ByteReader} br  //TODO(JSDOC).
+ */
 GifParser.prototype.parseHeader = function(metadata, br) {
   br.setByteOrder(ByteReader.LITTLE_ENDIAN);