Some comment improvements

joedolson · joedolson · commit bee61bb201f1 · 2026-01-10T16:01:25.000-06:00
diff --git a/scripts/vts.js b/scripts/vts.js
@@ -6,8 +6,6 @@
 (function ($) {
 	AblePlayer.prototype.injectVTS = function() {
 
-		// To add a transcript sorter to a web page: <div id="able-vts"></div>
-
 		var thisObj, $heading, $instructions, $p1, $p2, $ul, $li1, $li2, $li3,
 		$fieldset, $legend, i, $radioDiv, radioId, $label, $radio, $saveButton, $savedTable;
 
@@ -86,13 +84,13 @@
 				}
 				$fieldset.append( $fieldWrapper );
 				$('#able-vts').append($fieldset);
-
+				let vtsSave = this.translate( 'vtsSave', 'Generate new .vtt content' );
 				// Inject a button to generate new files.
 				$saveButton = $('<button>',{
 					'type': 'button',
 					'id': 'able-vts-save',
 					'value': 'save'
-				}).text( this.translate( 'vtsSave', 'Generate new .vtt files' ) );
+				}).text( vtsSave );
 				$('#able-vts').append($saveButton);
 
 				// Inject a table with one row for each cue in the default language
@@ -150,7 +148,7 @@
 						thisObj.parseVtsOutput($savedTable);
 					} else {
 						// cancel saving, and restore the table using edited content
-						$(this).attr('value','save').text(this.translate( 'vtsSave', 'Generate new .vtt files' ) );
+						$(this).attr('value','save').text( vtsSave );
 						$('#able-vts-output').remove();
 						$('#able-vts-instructions').show();
 						$('#able-vts > fieldset').show();
@@ -167,8 +165,6 @@
 
 		// TODO: Add support for trackDesc
 		// (to destinguish between tracks for the decribed vs non-described versions)
-
-		// Called from tracks.js
 		var srcFile, vtsCues;
 
 		srcFile = this.getFilenameFromPath(src);
diff --git a/scripts/youtube.js b/scripts/youtube.js
@@ -183,18 +183,14 @@
 		}
 	};
 
+	/**
+	 * Get data from the YouTube iFrame API. Pushes data into `this.tracks` and `this.captions`.
+	 * Initiates play to trigger loading the captions module, then stops and collects data.
+	 *
+	 * @returns {Promise} promise
+	 */
 	AblePlayer.prototype.getYouTubeCaptionTracks = function () {
 
-		// get data via YouTube IFrame Player API, and push data to this.tracks & this.captions
-		// NOTE: Caption tracks are not available through the IFrame Player API
-		// until AFTER the video has started playing.
-		// Therefore, this function plays the video briefly to load the captions module
-		// then stops the video and collects the data needed to build the cc menu
-		// This is stupid, but seemingly unavoidable.
-		// Caption tracks could be obtained through the YouTube Data API
-		// but this required authors to have a Google API key,
-		// which would complicate Able Player installation
-
 		var deferred = new this.defer();
 		var promise = deferred.promise();
 		var thisObj, ytTracks, i, trackLang, trackLabel, isDefaultTrack, apiTriggered = false;
@@ -320,10 +316,10 @@
 	AblePlayer.prototype.getYouTubeId = function (url) {
 
 		// return a YouTube ID, extracted from a full YouTube URL
-		// Supported URL patterns (with http or https):
-		// https://youtu.be/xxx
-		// https://www.youtube.com/watch?v=xxx
-		// https://www.youtube.com/embed/xxx
+		// Supported URL patterns:
+		// http|s://youtu.be/xxx
+		// http|s://www.youtube.com/watch?v=xxx
+		// http|s://www.youtube.com/embed/xxx
 
 		// in all supported patterns, the id is the last 11 characters
 		var idStartPos, id;
