diff options
| author | Xavier Morel <xmo@odoo.com> | 2018-12-11 15:24:09 +0000 |
|---|---|---|
| committer | Xavier Morel <xmo@odoo.com> | 2018-12-11 15:24:09 +0000 |
| commit | 43e062fabfa0b220df017c8617e033377c3f04e3 (patch) | |
| tree | 6e20e1b461f93fa3d1ab885a28bb4d389cc618f9 /addons/web/static/src | |
| parent | 448ba01ae93ca4e21e7090544b1d543085a26951 (diff) | |
[FIX] *: JS doc/docstring errors & warnings
closes odoo/odoo#29439
Diffstat (limited to 'addons/web/static/src')
5 files changed, 13 insertions, 14 deletions
diff --git a/addons/web/static/src/js/chrome/abstract_action.js b/addons/web/static/src/js/chrome/abstract_action.js index 226802ba76b..a5f98434ddb 100644 --- a/addons/web/static/src/js/chrome/abstract_action.js +++ b/addons/web/static/src/js/chrome/abstract_action.js @@ -31,7 +31,7 @@ var AbstractAction = Widget.extend(ActionMixin, { * to do that, it also needs a specific modelName. * * For example, the Discuss application adds the following line in its - * constructor: + * constructor:: * * this.controlPanelParams.modelName = 'mail.message'; * diff --git a/addons/web/static/src/js/chrome/action_mixin.js b/addons/web/static/src/js/chrome/action_mixin.js index 099244592ad..92d6716a7c0 100644 --- a/addons/web/static/src/js/chrome/action_mixin.js +++ b/addons/web/static/src/js/chrome/action_mixin.js @@ -102,14 +102,17 @@ var ActionMixin = { * This function is called when the current state of the action * should be known. For instance, if the action is a view controller, * this may be useful to reinstantiate a view in the same state. + * * Typically the state can (and should) be encoded in a query object of - * the form - * { - * context: {...}, - * groupBy: [...], - * domain = [...], - * orderedBy = [...], - * } + * the form:: + * + * { + * context: {...}, + * groupBy: [...], + * domain = [...], + * orderedBy = [...], + * } + * * where the context key can contain many information. * This method is mainly called during the creation of a custom filter. * diff --git a/addons/web/static/src/js/core/registry.js b/addons/web/static/src/js/core/registry.js index c6d35229639..cf898c647ca 100644 --- a/addons/web/static/src/js/core/registry.js +++ b/addons/web/static/src/js/core/registry.js @@ -41,7 +41,7 @@ var Registry = Class.extend({ * * @param {string} key * @param {any} value - * @param {[number]} score if given, this value will be used to order keys + * @param {number} [score] if given, this value will be used to order keys * @returns {Registry} can be used to chain add calls. */ add: function (key, value, score) { diff --git a/addons/web/static/src/js/services/data_manager.js b/addons/web/static/src/js/services/data_manager.js index afedaa1148f..348054691bc 100644 --- a/addons/web/static/src/js/services/data_manager.js +++ b/addons/web/static/src/js/services/data_manager.js @@ -126,8 +126,6 @@ return core.Class.extend({ /** * Loads the filters of a given model and optional action id. * - * @param {Object} [dataset] the dataset for which the filters are loaded - * @param {int} [action_id] the id of the action (optional) * @param {Object} params * @param {string} params.modelName * @param {Object} params.context @@ -176,7 +174,7 @@ return core.Class.extend({ /** * Calls 'unlink' on 'ir_filters'. * - * @param {integer} filterId, Id of the filter to remove + * @param {integer} filterId Id of the filter to remove * @return {Deferred} */ delete_filter: function (filterId) { diff --git a/addons/web/static/src/js/views/control_panel/control_panel_view.js b/addons/web/static/src/js/views/control_panel/control_panel_view.js index 3ba7afb2a60..0d842c4182d 100644 --- a/addons/web/static/src/js/views/control_panel/control_panel_view.js +++ b/addons/web/static/src/js/views/control_panel/control_panel_view.js @@ -43,8 +43,6 @@ var ControlPanelView = Factory.extend({ * breadcrumbs won't be rendered * @param {boolean} [params.withSearchBar=true] if set to false, no default * search bar will be rendered - * @param {boolean} [activateDefaultFavorite=false] determine if the default - * custom filters can be activated */ init: function (params) { var self = this; |
