From f1a85ba70a2412fb0d7bf789a758d8f2d2e86a02 Mon Sep 17 00:00:00 2001
From: Xavier Morel <xmo@odoo.com>
Date: Mon, 18 Sep 2017 10:03:51 +0200
Subject: [FIX] *: fix a bunch of incorrectly documented docstring

Fix a bunch of ill-documented/incomplete/incorrect method docs
Without this, the automatic doc generation does not work.
---
 addons/web_editor/static/src/js/editor/snippets.editor.js | 5 +++--
 addons/web_editor/static/src/js/widgets/ace.js            | 4 ++--
 addons/web_editor/static/src/js/widgets/widgets.js        | 6 +++++-
 3 files changed, 10 insertions(+), 5 deletions(-)

(limited to 'addons/web_editor/static/src')

diff --git a/addons/web_editor/static/src/js/editor/snippets.editor.js b/addons/web_editor/static/src/js/editor/snippets.editor.js
index c0299fc2969..c08fd39f0db 100644
--- a/addons/web_editor/static/src/js/editor/snippets.editor.js
+++ b/addons/web_editor/static/src/js/editor/snippets.editor.js
@@ -33,7 +33,8 @@ var SnippetEditor = Widget.extend({
     /**
      * @constructor
      * @param {Widget} parent
-     * @param {DOMElement} target
+     * @param {Element} target
+     * @param templateOptions
      */
     init: function (parent, target, templateOptions) {
         this._super.apply(this, arguments);
@@ -640,7 +641,7 @@ var SnippetsMenu = Widget.extend({
      * @private
      * @param {jQuery} [$selectorSiblings]
      *        elements which must have siblings drop zones
-     * @param {jQuery} [$selectorSiblings]
+     * @param {jQuery} [$selectorChildren]
      *        elements which must have child drop zones between each of existing
      *        child
      */
diff --git a/addons/web_editor/static/src/js/widgets/ace.js b/addons/web_editor/static/src/js/widgets/ace.js
index 3ba6d29b2b8..8053b7b12c8 100644
--- a/addons/web_editor/static/src/js/widgets/ace.js
+++ b/addons/web_editor/static/src/js/widgets/ace.js
@@ -790,7 +790,7 @@ var ViewEditor = Widget.extend({
      * is toggled -> reloads the resources accordingly.
      *
      * @private
-     * @param {Event}
+     * @param {Event} ev
      */
     _onIncludeAllLessChange: function (ev) {
         this.options.includeAllLess = $(ev.target).prop('checked');
@@ -801,7 +801,7 @@ var ViewEditor = Widget.extend({
      * included is toggled -> reloads the resources accordingly.
      *
      * @private
-     * @param {Event}
+     * @param {Event} ev
      */
     _onIncludeBundlesChange: function (ev) {
         this.options.includeBundles = $(ev.target).prop('checked');
diff --git a/addons/web_editor/static/src/js/widgets/widgets.js b/addons/web_editor/static/src/js/widgets/widgets.js
index d25f1c631e2..1c2f542c6cd 100644
--- a/addons/web_editor/static/src/js/widgets/widgets.js
+++ b/addons/web_editor/static/src/js/widgets/widgets.js
@@ -391,11 +391,15 @@ var ImageDialog = Widget.extend({
     },
 });
 
-/* list of font icons to load by editor. The icons are displayed in the media editor and
+/**
+ *  list of font icons to load by editor. The icons are displayed in the media editor and
  * identified like font and image (can be colored, spinned, resized with fa classes).
  * To add font, push a new object {base, parser}
+ *
  * - base: class who appear on all fonts (eg: fa fa-refresh)
  * - parser: regular expression used to select all font in css style sheets
+ *
+ * @type Array
  */
 var fontIcons = [{'base': 'fa', 'parser': /(?=^|\s)(\.fa-[0-9a-z_-]+::?before)/i}];
 
-- 
cgit v1.2.3