From 7065ea520c26d96e85f4e887fe871a58ae87a811 Mon Sep 17 00:00:00 2001
From: Xavier Morel <xmo@odoo.com>
Date: Tue, 5 Feb 2019 10:38:06 +0000
Subject: [PATCH] [FIX] *: various docstring formatting issues

Would yield block quotes instead of code blocks or lists or whatnot.
---
 .../static/src/js/mass_mailing_widget.js        |  6 +++---
 .../static/src/js/widgets/name_and_signature.js |  3 ++-
 .../static/src/js/wysiwyg/plugin/helper.js      | 17 +++++++++--------
 .../static/src/js/wysiwyg/plugin/unbreakable.js | 12 ++++++++----
 4 files changed, 22 insertions(+), 16 deletions(-)

diff --git a/addons/mass_mailing/static/src/js/mass_mailing_widget.js b/addons/mass_mailing/static/src/js/mass_mailing_widget.js
index cf97d3fd9a0..e87c6a11f70 100644
--- a/addons/mass_mailing/static/src/js/mass_mailing_widget.js
+++ b/addons/mass_mailing/static/src/js/mass_mailing_widget.js
@@ -35,9 +35,9 @@ var MassMailingFieldHtml = FieldHtml.extend({
     //--------------------------------------------------------------------------
 
     /**
-     * Commit the change in 'style-inline' on an other field
-     * nodeOptions:
-     *      - inline-field: fieldName to save the html value converted into inline code
+     * Commit the change in 'style-inline' on an other field nodeOptions:
+     *
+     * - inline-field: fieldName to save the html value converted into inline code
      *
      * @override
      */
diff --git a/addons/web/static/src/js/widgets/name_and_signature.js b/addons/web/static/src/js/widgets/name_and_signature.js
index 53355fc7aa4..c860b0a4361 100644
--- a/addons/web/static/src/js/widgets/name_and_signature.js
+++ b/addons/web/static/src/js/widgets/name_and_signature.js
@@ -52,8 +52,9 @@ var NameAndSignature = Widget.extend({
      * @param {string} [options.mode='draw'] - @see this.setMode
      * @param {string} [options.signatureType='signature'] - The type of
      *  signature used in 'auto' mode. Can be one of the following values:
+     *
      *  - 'signature': it will adapt the characters width to fit the whole
-     *      text in the image.
+     *    text in the image.
      *  - 'initial': it will adapt the space between characters to fill
      *      the image with the text. The text will be the first letter of
      *      every word in the name, separated by dots.
diff --git a/addons/web_editor/static/src/js/wysiwyg/plugin/helper.js b/addons/web_editor/static/src/js/wysiwyg/plugin/helper.js
index 0fe576adf8e..9d346d42a27 100644
--- a/addons/web_editor/static/src/js/wysiwyg/plugin/helper.js
+++ b/addons/web_editor/static/src/js/wysiwyg/plugin/helper.js
@@ -151,19 +151,20 @@ var HelperPlugin = AbstractPlugin.extend({
     },
     /**
      * Remove the dom between 2 points (respecting unbreakable rules).
-     * Returns an object:
-     * {
-     *  node: pointA.node (updated if necessary),
-     *  offset: pointA.offset (updated if necessary),
-     *  changed: bool (whether changes were applied)
-     * }
+     * Returns an object::
+     *
+     *     {
+     *         node: pointA.node (updated if necessary),
+     *         offset: pointA.offset (updated if necessary),
+     *         changed: bool (whether changes were applied)
+     *     }
      * 
      * @param {Object} pointA
      * @param {Node} pointA.node
-     * @param {Integer} pointA.offset
+     * @param {number} pointA.offset
      * @param {Object} pointB
      * @param {Node} pointB.node
-     * @param {Integer} pointB.offset
+     * @param {number} pointB.offset
      * @returns {Object} {node, offset, changed}
      */
     deleteBetween: function (pointA, pointB) {
diff --git a/addons/web_editor/static/src/js/wysiwyg/plugin/unbreakable.js b/addons/web_editor/static/src/js/wysiwyg/plugin/unbreakable.js
index 81a90d55413..388a3b2b2c9 100644
--- a/addons/web_editor/static/src/js/wysiwyg/plugin/unbreakable.js
+++ b/addons/web_editor/static/src/js/wysiwyg/plugin/unbreakable.js
@@ -33,7 +33,9 @@ var Unbreakable = AbstractPlugin.extend({
     //--------------------------------------------------------------------------
 
     /**
-     * Change the selection if it breaks an unbreakable node.
+     * Change the selection if it breaks an unbreakable node:
+     *
+     * .. code-block:: xml
      *
         <unbreakable id="a">
             content_1
@@ -56,6 +58,8 @@ var Unbreakable = AbstractPlugin.extend({
             </allow>
         </unbreakable>
 
+     * .. code-block: none
+
         START            END            RESIZE START     RESIZE END
 
         content_1       content_1       content_3       content_3   (find the first allowed node)
@@ -70,9 +74,9 @@ var Unbreakable = AbstractPlugin.extend({
         content_6       content_8       -               content_6
         content_7       content_8       -               content_8
         content_9       content_12      content_10      -
-        *
-        * @returns {WrappedRange}
-        */
+     *
+     * @returns {WrappedRange}
+     */
     secureRange: function () {
         var self = this;
         var range = this.context.invoke('editor.createRange');