summaryrefslogtreecommitdiff
path: root/addons/mail/static/src/js
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/mail/static/src/js
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/mail/static/src/js')
-rw-r--r--addons/mail/static/src/js/discuss.js12
-rw-r--r--addons/mail/static/src/js/emojis.js10
-rw-r--r--addons/mail/static/src/js/models/messages/message.js2
-rw-r--r--addons/mail/static/src/js/models/threads/channel.js4
-rw-r--r--addons/mail/static/src/js/models/threads/thread.js4
5 files changed, 17 insertions, 15 deletions
diff --git a/addons/mail/static/src/js/discuss.js b/addons/mail/static/src/js/discuss.js
index bdf78d291b4..4208fb41cfe 100644
--- a/addons/mail/static/src/js/discuss.js
+++ b/addons/mail/static/src/js/discuss.js
@@ -126,10 +126,12 @@ var ModeratorRejectMessageDialog = Dialog.extend({
* @param {Object} params
* @param {integer[]} params.messageIDs list of message IDs to send
* 'reject' decision reason
- * @param {function} params.proceedReject a function to call when the
- * moderator confirms the reason for rejecting the messages. This
- * function passes an object as the reason for reject, which is
- * structured as follow:
+ * @param {function} params.proceedReject
+ *
+ * a function to call when the
+ * moderator confirms the reason for rejecting the
+ * messages. This function passes an object as the
+ * reason for reject, which is structured as follow::
*
* {
* title: <string>,
@@ -602,7 +604,7 @@ var Discuss = AbstractAction.extend(ControlPanelMixin, {
* cancel his action.
*
* @private
- * @param {number[]]} messageIDs list of message IDs to reject
+ * @param {number[]} messageIDs list of message IDs to reject
*/
_rejectMessages: function (messageIDs) {
var self = this;
diff --git a/addons/mail/static/src/js/emojis.js b/addons/mail/static/src/js/emojis.js
index 4fedb5647a6..dcd53a3c5d1 100644
--- a/addons/mail/static/src/js/emojis.js
+++ b/addons/mail/static/src/js/emojis.js
@@ -14,11 +14,11 @@ odoo.define('mail.emojis', function (require) {
* This data represent all the available emojis that are supported on the web
* client:
*
- * - key: this is the source representation of an emoji, i.e. its "character"
- * representation. This is a string that can be easily typed by the
- * user and then translated to its unicode representation (see value)
- * - value: this is the unicode representation of an emoji, i.e. its "true"
- * representation in the system.
+ * - key: this is the source representation of an emoji, i.e. its "character"
+ * representation. This is a string that can be easily typed by the
+ * user and then translated to its unicode representation (see value)
+ * - value: this is the unicode representation of an emoji, i.e. its "true"
+ * representation in the system.
*/
var data = {
":)": "😊",
diff --git a/addons/mail/static/src/js/models/messages/message.js b/addons/mail/static/src/js/models/messages/message.js
index 06b776ea580..9bf7a79d1b9 100644
--- a/addons/mail/static/src/js/models/messages/message.js
+++ b/addons/mail/static/src/js/models/messages/message.js
@@ -132,7 +132,7 @@ var Message = AbstractMessage.extend(Mixins.EventDispatcherMixin, ServicesMixin
/**
* Get the text to display for the author of the message
*
- * Rule of precedence for the displayed author:
+ * Rule of precedence for the displayed author::
*
* author name > sender email > "anonymous"
*
diff --git a/addons/mail/static/src/js/models/threads/channel.js b/addons/mail/static/src/js/models/threads/channel.js
index 86482a71a6d..a2775297cb2 100644
--- a/addons/mail/static/src/js/models/threads/channel.js
+++ b/addons/mail/static/src/js/models/threads/channel.js
@@ -271,8 +271,8 @@ var Channel = ThreadWithCache.extend({
/**
* States whether this channel is a chat or not.
* These types of channels are chat:
- * - direct messages (DM)
- * - livechat
+ * - direct messages (DM)
+ * - livechat
*
* @override
* @returns {boolean}
diff --git a/addons/mail/static/src/js/models/threads/thread.js b/addons/mail/static/src/js/models/threads/thread.js
index 76d840a6100..fe9d23678d0 100644
--- a/addons/mail/static/src/js/models/threads/thread.js
+++ b/addons/mail/static/src/js/models/threads/thread.js
@@ -19,8 +19,8 @@ var Thread = AbstractThread.extend(Mixins.EventDispatcherMixin, ServicesMixin, {
/**
* @override
- * @param {mail.Manager} param.parent
* @param {Object} params
+ * @param {mail.Manager} params.parent
* @param {Object} params.data
* @param {string} [params.data.channel_type]
* @param {string} params.data.name
@@ -104,7 +104,7 @@ var Thread = AbstractThread.extend(Mixins.EventDispatcherMixin, ServicesMixin, {
* the new state in the interface.
*
* @override
- * @param {boolean} boolean
+ * @param {boolean} folded
*/
fold: function (folded) {
this._super.apply(this, arguments);