Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(4497)

Unified Diff: chrome/browser/resources/file_manager/js/metadata/byte_reader.js

Issue 12254003: [Cleanup] Files.app: add '@return' annotations (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: rebase Created 7 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | chrome/browser/resources/file_manager/js/metadata/id3_parser.js » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: chrome/browser/resources/file_manager/js/metadata/byte_reader.js
diff --git a/chrome/browser/resources/file_manager/js/metadata/byte_reader.js b/chrome/browser/resources/file_manager/js/metadata/byte_reader.js
index 58a33c7f590ca2176e2fcc04b7c37ed23286070d..bb81170226c369c2f7e7585b45cdd1f8095ceeec 100644
--- a/chrome/browser/resources/file_manager/js/metadata/byte_reader.js
+++ b/chrome/browser/resources/file_manager/js/metadata/byte_reader.js
@@ -63,6 +63,7 @@ ByteReader.validateRead = function(pos, size, end) {
*
* This is a static utility function. There is a member function with the
* same name which side-effects the current read position.
+ * @return {string} //TODO(JSDOC).
*/
ByteReader.readString = function(dataView, pos, size, opt_end) {
ByteReader.validateRead(pos, size, opt_end || dataView.byteLength);
@@ -80,6 +81,7 @@ ByteReader.readString = function(dataView, pos, size, opt_end) {
*
* This is a static utility function. There is a member function with the
* same name which side-effects the current read position.
+ * @return {string} //TODO(JSDOC).
*/
ByteReader.readNullTerminatedString = function(dataView, pos, size, opt_end) {
ByteReader.validateRead(pos, size, opt_end || dataView.byteLength);
@@ -100,6 +102,7 @@ ByteReader.readNullTerminatedString = function(dataView, pos, size, opt_end) {
*
* This is a static utility function. There is a member function with the
* same name which side-effects the current read position.
+ * @return {string} //TODO(JSDOC).
*/
ByteReader.readNullTerminatedStringUTF16 = function(
dataView, pos, bom, size, opt_end) {
@@ -139,6 +142,7 @@ ByteReader.base64Alphabet_ =
*
* This is a static utility function. There is a member function with the
* same name which side-effects the current read position.
+ * @return {string} //TODO(JSDOC).
*/
ByteReader.readBase64 = function(dataView, pos, size, opt_end) {
ByteReader.validateRead(pos, size, opt_end || dataView.byteLength);
@@ -183,6 +187,7 @@ ByteReader.readBase64 = function(dataView, pos, size, opt_end) {
*
* This is a static utility function. There is a member function with the
* same name which side-effects the current read position.
+ * @return {string} //TODO(JSDOC).
*/
ByteReader.readImage = function(dataView, pos, size, opt_end) {
opt_end = opt_end || dataView.byteLength;
@@ -208,6 +213,7 @@ ByteReader.readImage = function(dataView, pos, size, opt_end) {
/**
* Return true if the requested number of bytes can be read from the buffer.
+ * @return {boolean} //TODO(JSDOC).
*/
ByteReader.prototype.canRead = function(size) {
return this.pos_ + size <= this.view_.byteLength;
@@ -215,6 +221,7 @@ ByteReader.prototype.canRead = function(size) {
/**
* Return true if the current position is past the end of the buffer.
+ * @return {boolean} //TODO(JSDOC).
*/
ByteReader.prototype.eof = function() {
return this.pos_ >= this.view_.byteLength;
@@ -222,6 +229,7 @@ ByteReader.prototype.eof = function() {
/**
* Return true if the current position is before the beginning of the buffer.
+ * @return {boolean} //TODO(JSDOC).
*/
ByteReader.prototype.bof = function() {
return this.pos_ < 0;
@@ -229,6 +237,7 @@ ByteReader.prototype.bof = function() {
/**
* Return true if the current position is outside the buffer.
+ * @return {boolean} //TODO(JSDOC).
*/
ByteReader.prototype.beof = function() {
return this.pos_ >= this.view_.byteLength || this.pos_ < 0;
@@ -297,6 +306,7 @@ ByteReader.prototype.readScalar = function(width, opt_signed, opt_end) {
*
* Adjusts the current position on success. Throws an exception if the
* read would go past the end of the buffer.
+ * @return {string} //TODO(JSDOC).
*/
ByteReader.prototype.readString = function(size, opt_end) {
var rv = ByteReader.readString(this.view_, this.pos_, size, opt_end);
@@ -310,6 +320,7 @@ ByteReader.prototype.readString = function(size, opt_end) {
*
* Adjusts the current position on success. Throws an exception if the
* read would go past the end of the buffer.
+ * @return {string} //TODO(JSDOC).
*/
ByteReader.prototype.readNullTerminatedString = function(size, opt_end) {
var rv = ByteReader.readNullTerminatedString(this.view_,
@@ -333,6 +344,7 @@ ByteReader.prototype.readNullTerminatedString = function(size, opt_end) {
*
* Adjusts the current position on success. Throws an exception if the
* read would go past the end of the buffer.
+ * @return {string} //TODO(JSDOC).
*/
ByteReader.prototype.readNullTerminatedStringUTF16 =
function(bom, size, opt_end) {
@@ -361,6 +373,7 @@ ByteReader.prototype.readNullTerminatedStringUTF16 =
*
* Adjusts the current position on success. Throws an exception if the
* read would go past the end of the buffer.
+ * @return {Array.<*>} //TODO(JSDOC).
*/
ByteReader.prototype.readSlice = function(size, opt_end,
opt_arrayConstructor) {
@@ -380,6 +393,7 @@ ByteReader.prototype.readSlice = function(size, opt_end,
*
* Adjusts the current position on success. Throws an exception if the
* read would go past the end of the buffer.
+ * @return {string} //TODO(JSDOC).
*/
ByteReader.prototype.readBase64 = function(size, opt_end) {
var rv = ByteReader.readBase64(this.view_, this.pos_, size, opt_end);
@@ -392,6 +406,7 @@ ByteReader.prototype.readBase64 = function(size, opt_end) {
*
* Adjusts the current position on success. Throws an exception if the
* read would go past the end of the buffer.
+ * @return {string} //TODO(JSDOC).
*/
ByteReader.prototype.readImage = function(size, opt_end) {
var rv = ByteReader.readImage(this.view_, this.pos_, size, opt_end);
@@ -442,6 +457,7 @@ ByteReader.prototype.popSeek = function() {
/**
* Return the current read position.
+ * @return {number} //TODO(JSDOC).
*/
ByteReader.prototype.tell = function() {
return this.pos_;
« no previous file with comments | « no previous file | chrome/browser/resources/file_manager/js/metadata/id3_parser.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698