[Cleanup] Files.app: adds '@private' annotations to JSdoc of private methods.

chrome/browser/resources/file_manager/js/metadata/id3_parser.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.
 
 importScripts('function_sequence.js');
 importScripts('function_parallel.js');
 
 function Id3Parser(parent) {
   MetadataParser.call(this, parent, 'id3', /\.(mp3)$/i);
 }
 
 Id3Parser.prototype = {__proto__: MetadataParser.prototype};
 
 /**
  * Reads synchsafe integer.
  * 'SynchSafe' term is taken from id3 documentation.
  *
+ * @private
  * @param {ByteReader} reader - reader to use.
  * @param {int} length - bytes to read.
  * @return {int}
  */
 Id3Parser.readSynchSafe_ = function(reader, length) {
   var rv = 0;
 
   switch (length) {
     case 4:
       rv = reader.readScalar(1, false) << 21;
     case 3:
       rv |= reader.readScalar(1, false) << 14;
     case 2:
       rv |= reader.readScalar(1, false) << 7;
     case 1:
       rv |= reader.readScalar(1, false);
   }
 
   return rv;
 };
 
 /**
  * Reads 3bytes integer.
  *
+ * @private
  * @param {ByteReader} reader - reader to use.
  * @return {int}
  */
 Id3Parser.readUInt24_ = function(reader) {
   return reader.readScalar(2, false) << 16 | reader.readScalar(1, false);
 };
 
 /**
  * Reads string from reader with specified encoding
  *
+ * @private
  * @param {ByteReader} reader reader to use.
  * @param {int} encoding string encoding.
  * @param {int} size maximum string size. Actual result may be shorter.
- *
  */
 Id3Parser.prototype.readString_ = function(reader, encoding, size) {
   switch (encoding) {
     case Id3Parser.v2.ENCODING.ISO_8859_1:
       return reader.readNullTerminatedString(size);
 
     case Id3Parser.v2.ENCODING.UTF_16:
       return reader.readNullTerminatedStringUTF16(true, size);
 
     case Id3Parser.v2.ENCODING.UTF_16BE:
       return reader.readNullTerminatedStringUTF16(false, size);
 
     case Id3Parser.v2.ENCODING.UTF_8:
       // TODO: implement UTF_8.
       this.log('UTF8 encoding not supported, used ISO_8859_1 instead');
       return reader.readNullTerminatedString(size);
 
     default: {
       this.log('Unsupported encoding in ID3 tag: ' + encoding);
       return '';
     }
   }
 };
 
 /**
  * Reads text frame from reader.
  *
+ * @private
  * @param {ByteReader} reader reader to use.
  * @param {int} majorVersion major id3 version to use.
  * @param {Object} frame frame so store data at.
  * @param {int} end frame end position in reader.
  */
 Id3Parser.prototype.readTextFrame_ = function(reader,
                                               majorVersion,
                                               frame,
                                               end) {
   frame.encoding = reader.readScalar(1, false, end);
   frame.value = this.readString_(reader, frame.encoding, end - reader.tell());
 };
 
 /**
  * Reads user defined text frame from reader.
  *
+ * @private
  * @param {ByteReader} reader reader to use.
  * @param {int} majorVersion major id3 version to use.
  * @param {Object} frame frame so store data at.
  * @param {int} end frame end position in reader.
  */
 Id3Parser.prototype.readUserDefinedTextFrame_ = function(reader,
                                                          majorVersion,
                                                          frame,
                                                          end) {
   frame.encoding = reader.readScalar(1, false, end);
 
   frame.description = this.readString_(
       reader,
       frame.encoding,
       end - reader.tell());
 
   frame.value = this.readString_(
       reader,
       frame.encoding,
       end - reader.tell());
 };
 
+/**
+ * @private
+ */
 Id3Parser.prototype.readPIC_ = function(reader, majorVersion, frame, end) {
   frame.encoding = reader.readScalar(1, false, end);
   frame.format = reader.readNullTerminatedString(3, end - reader.tell());
   frame.pictureType = reader.readScalar(1, false, end);
   frame.description = this.readString_(reader,
                                        frame.encoding,
                                        end - reader.tell());
 
 
   if (frame.format == '-->') {
     frame.imageUrl = reader.readNullTerminatedString(end - reader.tell());
   } else {
     frame.imageUrl = reader.readImage(end - reader.tell());
   }
 };
 
+/**
+ * @private
+ */
 Id3Parser.prototype.readAPIC_ = function(reader, majorVersion, frame, end) {
   this.vlog('Extracting picture');
   frame.encoding = reader.readScalar(1, false, end);
   frame.mime = reader.readNullTerminatedString(end - reader.tell());
   frame.pictureType = reader.readScalar(1, false, end);
   frame.description = this.readString_(
       reader,
       frame.encoding,
       end - reader.tell());
 
   if (frame.mime == '-->') {
     frame.imageUrl = reader.readNullTerminatedString(end - reader.tell());
   } else {
     frame.imageUrl = reader.readImage(end - reader.tell());
   }
 };
 
 /**
  * Reads string from reader with specified encoding
  *
+ * @private
  * @param {ByteReader} reader  reader to use.
  * @return {Object} frame read.
  */
 Id3Parser.prototype.readFrame_ = function(reader, majorVersion) {
   if (reader.eof())
     return null;
 
   var frame = {};
 
   reader.pushSeek(reader.tell(), ByteReader.SEEK_BEG);
@@ skipping 502 matching lines @@
     TYER: 'ID3_YEAR',
     WCOP: 'ID3_COPYRIGHT',
     WOAF: 'ID3_OFFICIAL_AUDIO_FILE_WEBPAGE',
     WOAR: 'ID3_OFFICIAL_ARTIST',
     WOAS: 'ID3_OFFICIAL_AUDIO_SOURCE_WEBPAGE',
     WPUB: 'ID3_PUBLISHERS_OFFICIAL_WEBPAGE'
   }
 };
 
 MetadataDispatcher.registerParserClass(Id3Parser);