OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 /** | 5 /** |
6 * @fileoverview Base interface for all speech rule stores. | 6 * @fileoverview Base interface for all speech rule stores. |
7 * | 7 * |
8 * A speech rule store exposes the minimal set of methods a speech rule | 8 * A speech rule store exposes the minimal set of methods a speech rule |
9 * author needs for a particular markup type such as MathML or HTML | 9 * author needs for a particular markup type such as MathML or HTML |
10 * (definition). A rule provider also acts as the permanent and authoritative | 10 * (definition). A rule provider also acts as the permanent and authoritative |
(...skipping 26 matching lines...) Expand all Loading... |
37 * Retrieves the first rule satisfying a given predicate. | 37 * Retrieves the first rule satisfying a given predicate. |
38 * @param {function(cvox.SpeechRule): boolean} pred A predicate on speech rules. | 38 * @param {function(cvox.SpeechRule): boolean} pred A predicate on speech rules. |
39 * @return {cvox.SpeechRule} The first speech rule in the store satisfying pred. | 39 * @return {cvox.SpeechRule} The first speech rule in the store satisfying pred. |
40 */ | 40 */ |
41 cvox.SpeechRuleStore.prototype.findRule = goog.abstractMethod; | 41 cvox.SpeechRuleStore.prototype.findRule = goog.abstractMethod; |
42 | 42 |
43 | 43 |
44 /** | 44 /** |
45 * Retrieves all rules satisfying a given predicate. | 45 * Retrieves all rules satisfying a given predicate. |
46 * @param {function(cvox.SpeechRule): boolean} pred A predicate on speech rules. | 46 * @param {function(cvox.SpeechRule): boolean} pred A predicate on speech rules. |
47 * @return {Array.<cvox.SpeechRule>} All speech rules in the store satisfying | 47 * @return {Array<cvox.SpeechRule>} All speech rules in the store satisfying |
48 * pred. | 48 * pred. |
49 */ | 49 */ |
50 cvox.SpeechRuleStore.prototype.findAllRules = goog.abstractMethod; | 50 cvox.SpeechRuleStore.prototype.findAllRules = goog.abstractMethod; |
51 | 51 |
52 | 52 |
53 /** | 53 /** |
54 * Retrieves a rule for the given node if one exists. | 54 * Retrieves a rule for the given node if one exists. |
55 * @param {Node} node A node. | 55 * @param {Node} node A node. |
56 * @param {!cvox.SpeechRule.DynamicCstr} dynamic Additional dynamic | 56 * @param {!cvox.SpeechRule.DynamicCstr} dynamic Additional dynamic |
57 * constraints. These are matched against properties of a rule. | 57 * constraints. These are matched against properties of a rule. |
58 * @return {cvox.SpeechRule} The actions of the speech rule if it exists. | 58 * @return {cvox.SpeechRule} The actions of the speech rule if it exists. |
59 */ | 59 */ |
60 cvox.SpeechRuleStore.prototype.lookupRule = goog.abstractMethod; | 60 cvox.SpeechRuleStore.prototype.lookupRule = goog.abstractMethod; |
61 | 61 |
62 | 62 |
63 // TODO(sorge): Propagate this documentation *everywhere* once these | 63 // TODO(sorge): Propagate this documentation *everywhere* once these |
64 // args/descriptions are hardened/cleared up. | 64 // args/descriptions are hardened/cleared up. |
65 /** | 65 /** |
66 * Defines a new speech rule from given components. | 66 * Defines a new speech rule from given components. |
67 * @param {string} name Name of the rule. It does not have to be unique. | 67 * @param {string} name Name of the rule. It does not have to be unique. |
68 * @param {string} dynamic Dynamic constraint annotation of the rule. | 68 * @param {string} dynamic Dynamic constraint annotation of the rule. |
69 * @param {string} action String version of the speech rule. | 69 * @param {string} action String version of the speech rule. |
70 * @param {string} prec Precondition of the rule. | 70 * @param {string} prec Precondition of the rule. |
71 * @param {...string} constr Additional constraints. | 71 * @param {...string} constr Additional constraints. |
72 * @return {cvox.SpeechRule} The newly defined rule. | 72 * @return {cvox.SpeechRule} The newly defined rule. |
73 */ | 73 */ |
74 cvox.SpeechRuleStore.prototype.defineRule = goog.abstractMethod; | 74 cvox.SpeechRuleStore.prototype.defineRule = goog.abstractMethod; |
OLD | NEW |