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

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

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 function ByteReader(arrayBuffer, opt_offset, opt_length) {
   opt_offset = opt_offset || 0;
   opt_length = opt_length || (arrayBuffer.byteLength - opt_offset);
   this.view_ = new DataView(arrayBuffer, opt_offset, opt_length);
   this.pos_ = 0;
   this.seekStack_ = [];
   this.setByteOrder(ByteReader.BIG_ENDIAN);
 }
 
 // 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).
  *
  * Static utility function.
  */
 ByteReader.validateRead = function(pos, size, end) {
   if (pos < 0 || pos >= end)
     throw new Error('Invalid read position');
 
@@ skipping 60 matching lines @@
 
   for (var i = start; i < size; i += 2) {
     var code = dataView.getUint16(pos + i, littleEndian);
     if (code == 0) break;
     codes.push(code);
   }
 
   return String.fromCharCode.apply(null, codes);
 };
 
+/**
+ * @const
+ * @type {Array.<string>}
+ * @private
+ */
 ByteReader.base64Alphabet_ =
     ('ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/').
     split('');
 
 /**
  * Read as a sequence of bytes, returning them as a single base64 encoded
  * string.
  *
  * This is a static utility function.  There is a member function with the
  * same name which side-effects the current read position.
@@ skipping 106 matching lines @@
  * You may optionally pass opt_end to override what is considered to be the
  * end of the buffer.
  */
 ByteReader.prototype.validateRead = function(size, opt_end) {
   if (typeof opt_end == 'undefined')
     opt_end = this.view_.byteLength;
 
   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';
 
   switch (width) {
     case 1:
       method += '8';
       break;
 
     case 2:
       method += '16';
@@ skipping 165 matching lines @@
 ByteReader.prototype.popSeek = function() {
   this.seek(this.seekStack_.pop());
 };
 
 /**
  * Return the current read position.
  */
 ByteReader.prototype.tell = function() {
   return this.pos_;
 };