[FIX] *: JS doc/docstring errors & warnings

closes odoo/odoo#29439
This commit is contained in:
Xavier Morel
2018-12-11 15:24:09 +00:00
parent 448ba01ae9
commit 43e062fabf
8 changed files with 18 additions and 17 deletions
@@ -132,9 +132,9 @@ var ThreadWindow = AbstractThreadWindow.extend({
*
* Do not display the input in the following cases:
*
* - no thread related to this window
* - window of a mailbox (temp: let us have mailboxes in window mode)
* - window of a thread with mass mailing
* - no thread related to this window
* - window of a mailbox (temp: let us have mailboxes in window mode)
* - window of a thread with mass mailing
*
* Any other threads show the input in the window.
*
@@ -279,6 +279,7 @@ var ProductConfiguratorMixin = {
/**
* Will return a deferred:
*
* - If the product already exists, immediately resolves it with the product_id
* - If the product does not exist yet ("dynamic" variant creation), this method will
* create the product first and then resolve the deferred with the created product's id
@@ -28,6 +28,7 @@ var ProductConfiguratorFormRenderer = FormRenderer.extend(ProductConfiguratorMix
* Renders the product configurator within the form
*
* Will also:
*
* - add events handling for variant changes
* - trigger variant change to compute the price and other
* variant specific changes
@@ -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';
*
@@ -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.
*
+1 -1
View File
@@ -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) {
@@ -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) {
@@ -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;