summaryrefslogtreecommitdiff
path: root/addons/web/static/src/js/widgets
diff options
context:
space:
mode:
authorXavier Morel <xmo@odoo.com>2018-07-24 12:06:13 +0200
committerXavier Morel <xmo@odoo.com>2018-07-24 12:06:13 +0200
commita56372a4caa8b716ac0a4c36b3265ddce2d7b8d1 (patch)
tree876be16ae875c3b99c871ee258dd6385f9c4e9c3 /addons/web/static/src/js/widgets
parent26fbf933877ddfdb32d00f2c62d4434193406492 (diff)
[FIX] various broken JS docstrings
Resulting in sphinx warnings or ill-formatted doc all the way to the doc not building at all.
Diffstat (limited to 'addons/web/static/src/js/widgets')
-rw-r--r--addons/web/static/src/js/widgets/dropdown_menu.js37
-rw-r--r--addons/web/static/src/js/widgets/rainbow_man.js8
2 files changed, 19 insertions, 26 deletions
diff --git a/addons/web/static/src/js/widgets/dropdown_menu.js b/addons/web/static/src/js/widgets/dropdown_menu.js
index 6fb8aab9bb4..a3a83519678 100644
--- a/addons/web/static/src/js/widgets/dropdown_menu.js
+++ b/addons/web/static/src/js/widgets/dropdown_menu.js
@@ -21,24 +21,23 @@ var DropdownMenu = Widget.extend({
* override
*
* @param {Widget} parent
- * @param {Object} dropdowHeader object used to customize the dropdown menu. The keys:
- * - 'title' (e.g. 'Group By')
- * - 'icon' (e.g. 'fa-bars')
- * - 'symbol' (e.g. 'caret')
- * - 'category' (describes the type of items)
- * - 'style' (button style)
- * @param {Object} items list of menu items (type IGMenuItem below)
- * interface IMenuItem {
- * itemId: string; (optional) unique id associated with the item
- * description: string; label printed on screen
- * groupId: string;
- * isActive: boolean; (optional) determines if the item is considered active
- * isOpen: boolean; (optional) in case there are options the submenu presenting the options
- * is opened or closed according to isOpen
- * isRemovable: boolean; (optional) can be removed from menu
- * options: array of objects with 'optionId' and 'description' keys; (optional)
- * currentOptionId: string refers to an optionId that is activated if item is active (optional)
- * }
+ * @param {Object} dropdownHeader object used to customize the dropdown menu.
+ * @param {String} dropdownHeader.title
+ * @param {String} dropdownHeader.icon
+ * @param {String} dropdownHeader.symbol
+ * @param {String} dropdownHeader.category descripbes the type of items
+ * @param {String} dropdownHeader.style the button style
+ * @param {Object[]} items list of menu items
+ *
+ * Menu items:
+ *
+ * * itemId: string; (optional) unique id associated with the item
+ * * description: string; label printed on screen
+ * * groupId: string;
+ * * isActive: boolean; (optional) determines if the item is considered active
+ * * isOpen: boolean; (optional) in case there are options the submenu presenting the options is opened or closed according to isOpen
+ * * isRemovable: boolean; (optional) can be removed from menu options: array of objects with 'optionId' and 'description' keys; (optional)
+ * * currentOptionId: string refers to an optionId that is activated if item is active (optional)
*/
init: function (parent, dropdownHeader, items) {
this._super(parent);
@@ -67,7 +66,7 @@ var DropdownMenu = Widget.extend({
//--------------------------------------------------------------------------
/**
- * @param {Array[number]} groupIds
+ * @param {Number[]} groupIds
*/
unsetGroups: function (groupIds) {
var self = this;
diff --git a/addons/web/static/src/js/widgets/rainbow_man.js b/addons/web/static/src/js/widgets/rainbow_man.js
index e46201584bc..99a8f9dba79 100644
--- a/addons/web/static/src/js/widgets/rainbow_man.js
+++ b/addons/web/static/src/js/widgets/rainbow_man.js
@@ -25,13 +25,7 @@ var RainbowMan = Widget.extend({
* @constructor
* @param {Object} [options]
* @param {string} [options.message] Message to be displayed on rainbowman card
- * @param {string} [options.fadeout='medium'] Delay for rainbowman to disappear
- * [options.fadeout='fast'] will make rainbowman dissapear quickly,
- * [options.fadeout='medium'] and [options.fadeout='slow'] will wait
- * little longer before disappearing (can be used when [options.message]
- * is longer),
- * [options.fadeout='no'] will keep rainbowman on screen until user clicks
- * anywhere outside rainbowman
+ * @param {string} [options.fadeout='medium'] Delay for rainbowman to disappear. 'fast' will make rainbowman dissapear quickly, 'medium' and 'slow' will wait little longer before disappearing (can be used when options.message is longer), 'no' will keep rainbowman on screen until user clicks anywhere outside rainbowman
* @param {string} [options.img_url] URL of the image to be displayed
*/
init: function (options) {