|
10 | 10 | * @author H. Snater < mediawiki@snater.com > |
11 | 11 | * |
12 | 12 | * @constructor |
13 | | - * |
14 | | - * @param {Object} options |
15 | 13 | */ |
16 | | -var SELF = vf.ValueFormatter = function VpValueFormatter( options ) { |
17 | | - this._options = $.extend( {}, options || {} ); |
| 14 | +var SELF = vf.ValueFormatter = function VpValueFormatter() { |
18 | 15 | }; |
19 | 16 |
|
20 | 17 | /** |
21 | 18 | * @class valueFormatters.ValueFormatter |
22 | 19 | */ |
23 | 20 | $.extend( SELF.prototype, { |
24 | | - /** |
25 | | - * Formatter options. |
26 | | - * @property {Object} |
27 | | - * @private |
28 | | - */ |
29 | | - _options: null, |
30 | | - |
31 | | - /** |
32 | | - * Returns the formatter's options as set in the constructor. |
33 | | - * |
34 | | - * @return {Object} |
35 | | - */ |
36 | | - getOptions: function() { |
37 | | - return $.extend( {}, this._options ); |
38 | | - }, |
39 | 21 |
|
40 | 22 | /** |
41 | 23 | * Formats a value. Will return a jQuery.Promise which will be resolved if formatting is |
42 | 24 | * successful or rejected if it fails. There are various reasons why formatting could fail, e.g. |
43 | | - * the formatter is using the API and the API cannot be reached. In case of success, the |
| 25 | + * the formatter is using an API and the API cannot be reached. In case of success, the |
44 | 26 | * callbacks will be passed a dataValues.DataValue object. In case of failure, the callback's |
45 | 27 | * parameter will be an error object of some sort (not implemented yet!). |
46 | 28 | * @abstract |
47 | 29 | * |
48 | 30 | * @param {dataValues.DataValue} dataValue |
49 | | - * @param {string} [dataTypeId] |
50 | | - * @param {string} [outputType] The output's preferred MIME type |
51 | 31 | * @return {Object} jQuery.Promise |
52 | 32 | * @return {Function} return.done |
53 | 33 | * @return {string|null} return.done.formatted Formatted DataValue. |
|
0 commit comments