js doc tweaks

nfriedly · web-flow · commit fd0a40013cb6 · 2017-10-30T12:41:08.000-04:00
Correct param type and return type. Clarify that the file is edited in place.
diff --git a/text-to-speech/v1.js b/text-to-speech/v1.js
@@ -75,7 +75,8 @@ TextToSpeechV1.prototype.synthesize = function(params, callback) {
 /**
  * Repair the WAV header of an audio/wav file.
  *
- * @param {Object} wavFileData
+ * @param {Buffer} wavFileData - Wave audio - will be edited in place and returned
+ * @return {Buffer} wavFileData - the original Buffer, with a correct header
  */
 
 TextToSpeechV1.prototype.repairWavHeader = function(wavFileData) {

Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,8 @@ TextToSpeechV1.prototype.synthesize = function(params, callback) {`
`75`	`75`	`/**`
`76`	`76`	`* Repair the WAV header of an audio/wav file.`
`77`	`77`	`*`
`78`		`- * @param {Object} wavFileData`
	`78`	`+ * @param {Buffer} wavFileData - Wave audio - will be edited in place and returned`
	`79`	`+ * @return {Buffer} wavFileData - the original Buffer, with a correct header`
`79`	`80`	`*/`
`80`	`81`
`81`	`82`	`TextToSpeechV1.prototype.repairWavHeader = function(wavFileData) {`