Update docstrings

Author: rochars

lib/parsers/binary/index.js

@@ -23,12 +23,11 @@
  */
 
 /**
- * @fileoverview JavaScript binary parser for any browser or environment.
+ * @fileoverview binary parser.
  * @see https://github.com/rochars/byte-data
+ * @see https://github.com/rochars/wavefile
  */
 
-/** @module byte-data */
-
 import { endianness } from './lib/endianness';
 import { pack as packUTF8, unpack as unpackUTF8 } from './lib/utf8-parser';
 import { IntParser } from './lib/int-parser';
@@ -49,7 +48,6 @@ export function unpackString(buffer, index=0, end=buffer.length) {
  * Write a string of UTF-8 characters as a byte buffer.
  * @param {string} str The string to pack.
  * @return {!Array<number>} The UTF-8 string bytes.
- * @throws {TypeError} If 'str' is not a string.
  */
 export function packString(str) {
   /** @type {!Array<number>} */
@@ -64,7 +62,6 @@ export function packString(str) {
  * @param {!(Uint8Array|Array<number>)} buffer The output buffer.
  * @param {number} [index=0] The buffer index to start writing.
  * @return {number} The next index to write in the buffer.
- * @throws {TypeError} If 'str' is not a string.
  */
 export function packStringTo(str, buffer, index=0) {
   return packUTF8(str, buffer, index);
@@ -83,8 +80,6 @@ export function packStringTo(str, buffer, index=0) {
  * @param {number} [index=0] The buffer index to start writing.
  * @return {number} The next index to write.
  * @throws {Error} If the type definition is not valid.
- * @throws {RangeError} On overflow if clamp is set to false.
- * @throws {TypeError} If 'values' is not a array of numbers.
  */
 export function packArrayTo(values, theType, buffer, index=0) {
   theType = theType || {};
@@ -150,9 +145,6 @@ export function unpackArrayTo(
  * @param {number} [index=0] The buffer index to write.
  * @return {number} The next index to write.
  * @throws {Error} If the type definition is not valid.
- * @throws {RangeError} On overflow if clamp is set to false.
- * @throws {TypeError} If 'value' is not a number.
- * @throws {TypeError} If 'value' is not a int and type is int.
  */
 export function packTo(value, theType, buffer, index=0) {
   return packArrayTo([value], theType, buffer, index);
@@ -167,7 +159,6 @@ export function packTo(value, theType, buffer, index=0) {
  *   be: (boolean|undefined)}} theType The type definition.
  * @return {!Array<number>} The packed value.
  * @throws {Error} If the type definition is not valid.
- * @throws {TypeError} If 'value' is not a number.
  */
 export function pack(value, theType) {
   /** @type {!Array<number>} */
@@ -186,7 +177,6 @@ export function pack(value, theType) {
  * @param {number} [index=0] The buffer index to read.
  * @return {number}
  * @throws {Error} If the type definition is not valid.
- * @throws {Error} On bad input buffer length if on safe mode.
  */
 export function unpack(buffer, theType, index=0) {
   let output = [];
@@ -202,7 +192,6 @@ export function unpack(buffer, theType, index=0) {
  * @param {number} start The buffer index to start reading.
  * @param {number} end The buffer index to stop reading.
  * @param {!Object} parser The parser.
- * @throws {Error} If the type definition is not valid.
  * @private
  */
 function unpack_(buffer, output, start, end, parser) {
@@ -230,7 +219,6 @@ function copyBuffer_(buffer) {
  * @param {number} start The buffer index to start reading.
  * @param {number} end The buffer index to stop reading.
  * @param {number} offset The number of bytes used by the type.
- * @throws {Error} On bad buffer length, if safe.
  * @private
  */
 function getUnpackLen_(buffer, start, end, offset) {

lib/parsers/binary/lib/endianness.js

@@ -25,6 +25,7 @@
 /**
  * @fileoverview A function to swap endianness in byte buffers.
  * @see https://github.com/rochars/byte-data
+ * @see https://github.com/rochars/wavefile
  */
 
 /**

lib/parsers/binary/lib/float-parser.js

@@ -27,6 +27,7 @@
 /**
  * @fileoverview Encode and decode IEEE 754 floating point numbers.
  * @see https://github.com/rochars/byte-data
+ * @see https://github.com/rochars/wavefile
  * @see https://bitbucket.org/lindenlab/llsd/raw/7d2646cd3f9b4c806e73aebc4b32bd81e4047fdc/js/typedarray.js
  * @see https://github.com/kazuho/ieee754.js/blob/master/ieee754.js
  */
@@ -84,7 +85,6 @@ export class FloatParser {
    * @param {number} num The number.
    * @param {number} index The index to write on the buffer.
    * @return {number} The next index to write on the buffer.
-   * @throws {TypeError} If input is not a number.
    */
   pack(buffer, num, index) {
     // Round overflows

lib/parsers/binary/lib/int-parser.js

@@ -25,6 +25,7 @@
 /**
  * @fileoverview Encode and decode int numbers to and from byte buffers.
  * @see https://github.com/rochars/byte-data
+ * @see https://github.com/rochars/wavefile
  */
 
 /**
@@ -74,8 +75,6 @@ export class IntParser {
    * @param {number} num The number. Overflows are truncated.
    * @param {number} [index=0] The index being written in the byte buffer.
    * @return {number} The next index to write on the byte buffer.
-   * @throws {RangeError} On overflow if clamp is set to false.
-   * @throws {TypeError} If num is not a number.
    */
   pack(buffer, num, index=0) {
     num = this.clamp_(Math.round(num));

lib/parsers/binary/lib/utf8-parser.js

@@ -23,8 +23,9 @@
  */
 
 /**
- * @fileoverview Functions to serialize and deserialize UTF-8 strings.
+ * @fileoverview Encode and decode UTF8 strings to and from byte buffers.
  * @see https://github.com/rochars/byte-data
+ * @see https://github.com/rochars/wavefile
  * @see https://encoding.spec.whatwg.org/#the-encoding
  * @see https://encoding.spec.whatwg.org/#utf-8-encoder
  */
@@ -109,7 +110,6 @@ export function unpack(buffer, start=0, end=buffer.length) {
  * @param {!Uint8Array|!Array<number>} buffer The buffer to pack the string to.
  * @param {number=} index The buffer index to start writing.
  * @return {number} The next index to write in the buffer.
- * @throws {TypeError} If 'str' is not a string.
  */
 export function pack(str, buffer, index=0) {
   /** @type {number} */