diff options
| author | Xavier Morel <xmo@odoo.com> | 2019-02-05 10:38:06 +0000 |
|---|---|---|
| committer | Xavier Morel <xmo@odoo.com> | 2019-02-18 08:56:07 +0000 |
| commit | 7065ea520c26d96e85f4e887fe871a58ae87a811 (patch) | |
| tree | 5aba2fa2f23e428b80f7ffd2c847fc2b3bf6c554 /addons/web_editor | |
| parent | 3f8d20b7785af4749e852461f0bd8a077b52e87e (diff) | |
[FIX] *: various docstring formatting issues
Would yield block quotes instead of code blocks or lists or whatnot.
Diffstat (limited to 'addons/web_editor')
| -rw-r--r-- | addons/web_editor/static/src/js/wysiwyg/plugin/helper.js | 17 | ||||
| -rw-r--r-- | addons/web_editor/static/src/js/wysiwyg/plugin/unbreakable.js | 12 |
2 files changed, 17 insertions, 12 deletions
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'); |
