update jsdoc to reflect optional parameters

shaharmor · web-flow · commit 9cb624f7cd1a · 2017-02-12T18:40:51.000+02:00
diff --git a/spark-md5.js b/spark-md5.js
@@ -596,7 +596,7 @@
      * A conversion will be applied if utf8 string is detected.
      *
      * @param {String}  str The string
-     * @param {Boolean} raw True to get the raw string, false to get the hex string
+     * @param {Boolean} [raw] True to get the raw string, false to get the hex string
      *
      * @return {String} The result
      */
@@ -610,7 +610,7 @@
      * Performs the md5 hash on a binary string.
      *
      * @param {String}  content The binary string
-     * @param {Boolean} raw     True to get the raw string, false to get the hex string
+     * @param {Boolean} [raw]     True to get the raw string, false to get the hex string
      *
      * @return {String} The result
      */
@@ -736,7 +736,7 @@
      * Performs the md5 hash on an array buffer.
      *
      * @param {ArrayBuffer} arr The array buffer
-     * @param {Boolean}     raw True to get the raw string, false to get the hex one
+     * @param {Boolean}     [raw] True to get the raw string, false to get the hex one
      *
      * @return {String} The result
      */

Original file line number	Diff line number	Diff line change
`@@ -596,7 +596,7 @@`
`596`	`596`	`* A conversion will be applied if utf8 string is detected.`
`597`	`597`	`*`
`598`	`598`	`* @param {String} str The string`
`599`		`- * @param {Boolean} raw True to get the raw string, false to get the hex string`
	`599`	`+ * @param {Boolean} [raw] True to get the raw string, false to get the hex string`
`600`	`600`	`*`
`601`	`601`	`* @return {String} The result`
`602`	`602`	`*/`
`@@ -610,7 +610,7 @@`
`610`	`610`	`* Performs the md5 hash on a binary string.`
`611`	`611`	`*`
`612`	`612`	`* @param {String} content The binary string`
`613`		`- * @param {Boolean} raw True to get the raw string, false to get the hex string`
	`613`	`+ * @param {Boolean} [raw] True to get the raw string, false to get the hex string`
`614`	`614`	`*`
`615`	`615`	`* @return {String} The result`
`616`	`616`	`*/`
`@@ -736,7 +736,7 @@`
`736`	`736`	`* Performs the md5 hash on an array buffer.`
`737`	`737`	`*`
`738`	`738`	`* @param {ArrayBuffer} arr The array buffer`
`739`		`- * @param {Boolean} raw True to get the raw string, false to get the hex one`
	`739`	`+ * @param {Boolean} [raw] True to get the raw string, false to get the hex one`
`740`	`740`	`*`
`741`	`741`	`* @return {String} The result`
`742`	`742`	`*/`