Use an enum for ChromeVox queue mode.

chrome/browser/resources/chromeos/chromevox/host/interface/tts_interface.js

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 /**
  * @fileoverview Defines a Tts interface.
  *
  * All TTS engines in ChromeVox conform to the this interface.
  *
  */
 
+goog.provide('cvox.QueueMode');

[Peter Lundblad, 2014/09/29 13:51:04]

In basically all other files, you should add a corresponding goog.require.

[dmazzoni, 2014/09/30 22:01:20]

Done.

+goog.provide('cvox.TtsCapturingEventListener');
 goog.provide('cvox.TtsInterface');
-goog.provide('cvox.TtsCapturingEventListener');
+
+/**
+ * Queue modes for calls to speak().

[Peter Lundblad, 2014/09/29 13:51:04]

nit: Qualify speak, i.e. {@code cvox.TtsInterface.speak} since this is
its own object outside of TtsInterface.

[dmazzoni, 2014/09/30 22:01:20]

Done.

+ *
+ * FLUSH: stop speech, clear everything, then speak this utterance.
+ * QUEUE: append this utterance to the end of the queue.
+ * CATEGORY_FLUSH: clear any utterances of the same category (as set by
+ *     properties['category']) from the queue, then enqueue this utterance.
+ * @enum
+ */
+cvox.QueueMode = {
+  FLUSH: 0,

[Peter Lundblad, 2014/09/29 13:51:04]

Would be nice to have the jsdoc inside the {} pair above each enum value.

[dmazzoni, 2014/09/30 22:01:20]

Done.

+  QUEUE: 1,
+  CATEGORY_FLUSH: 2
+};
 
 /**
  * @interface
  * An interface for clients who want to get notified when an utterance
  * starts or ends from any source.
  */
 cvox.TtsCapturingEventListener = function() { };
 
 /**
  * Called when any utterance starts.
  */
 cvox.TtsCapturingEventListener.prototype.onTtsStart = function() { };
 
 /**
  * Called when any utterance ends.
  */
 cvox.TtsCapturingEventListener.prototype.onTtsEnd = function() { };
 
 
 /**
  * @interface
  */
 cvox.TtsInterface = function() { };
 
 /**
  * Speaks the given string using the specified queueMode and properties.
  * @param {string} textString The string of text to be spoken.
- * @param {number=} queueMode The queue mode: cvox.AbstractTts.QUEUE_MODE_FLUSH
- *        for flush, cvox.AbstractTts.QUEUE_MODE_QUEUE for adding to queue.
+ * @param {cvox.QueueMode} queueMode The queue mode to use for speaking.

[David Tseng, 2014/09/26 22:29:23]

I pretty much just looked at this file. I assume Closure compiler correctly
enforces this now (so that speak('foo', 0) is no longer acceptable).

[dmazzoni, 2014/09/30 22:01:20]

Acknowledged.

  * @param {Object=} properties Speech properties to use for this utterance.
  * @return {cvox.TtsInterface} A tts object useful for chaining speak calls.
  */
 cvox.TtsInterface.prototype.speak =
     function(textString, queueMode, properties) { };
 
 
 /**
  * Returns true if the TTS is currently speaking.
  * @return {boolean} True if the TTS is speaking.
@@ skipping 21 matching lines @@
 cvox.TtsInterface.prototype.increaseOrDecreaseProperty =
     function(propertyName, increase) { };
 
 
 /**
  * Returns the default properties of the first tts that has default properties.
  * @param {string} property Name of property.
  * @return {?number} The default value.
  */
 cvox.TtsInterface.prototype.getDefaultProperty = function(property) { };