diff options
| author | Xavier Morel <xmo@odoo.com> | 2017-09-18 10:03:51 +0200 |
|---|---|---|
| committer | Géry Debongnie <ged@odoo.com> | 2017-09-18 11:54:39 +0200 |
| commit | f1a85ba70a2412fb0d7bf789a758d8f2d2e86a02 (patch) | |
| tree | e6e8d2142a12d75c8943b07c192f88ecd3ddf527 /addons/mail/static/src/js | |
| parent | 313f69e9487e991e4db33c75682342b185da5c73 (diff) | |
[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.
Diffstat (limited to 'addons/mail/static/src/js')
| -rw-r--r-- | addons/mail/static/src/js/activity.js | 2 | ||||
| -rw-r--r-- | addons/mail/static/src/js/chatter_composer.js | 6 | ||||
| -rw-r--r-- | addons/mail/static/src/js/document_viewer.js | 2 | ||||
| -rw-r--r-- | addons/mail/static/src/js/thread.js | 10 |
4 files changed, 10 insertions, 10 deletions
diff --git a/addons/mail/static/src/js/activity.js b/addons/mail/static/src/js/activity.js index 716f1ceed70..a2ae24dff91 100644 --- a/addons/mail/static/src/js/activity.js +++ b/addons/mail/static/src/js/activity.js @@ -13,7 +13,7 @@ var _t = core._t; /** * Set the 'label_delay' entry in activity data according to the deadline date - * @param {Array} list of activity Object + * @param {Array} activities list of activity Object * @return {Array} : list of modified activity Object */ var setDelayLabel = function(activities){ diff --git a/addons/mail/static/src/js/chatter_composer.js b/addons/mail/static/src/js/chatter_composer.js index 77c8834252f..908dfd8b1c5 100644 --- a/addons/mail/static/src/js/chatter_composer.js +++ b/addons/mail/static/src/js/chatter_composer.js @@ -89,7 +89,7 @@ var ChatterComposer = composer.BasicComposer.extend({ /** * Get the list of selected suggested partners - * @returns Array() : list of 'recipient' selected partners (may not be created in db) + * @returns {Array} list of 'recipient' selected partners (may not be created in db) **/ get_checked_suggested_partners: function () { var self = this; @@ -106,8 +106,8 @@ var ChatterComposer = composer.BasicComposer.extend({ /** * Check the additional partners (not necessary registered partners), and open a popup form view * for the ones who informations is missing. - * @param Array : list of 'recipient' partners to complete informations or validate - * @returns Deferred resolved with the list of checked suggested partners (real partner) + * @param {Array} checked_suggested_partners list of 'recipient' partners to complete informations or validate + * @returns {Deferred} resolved with the list of checked suggested partners (real partner) **/ check_suggested_partners: function (checked_suggested_partners) { var self = this; diff --git a/addons/mail/static/src/js/document_viewer.js b/addons/mail/static/src/js/document_viewer.js index b3ea0e18bfc..2fa34b613ba 100644 --- a/addons/mail/static/src/js/document_viewer.js +++ b/addons/mail/static/src/js/document_viewer.js @@ -34,7 +34,7 @@ var DocumentViewer = Widget.extend({ * Documents that are not of type image or video are filtered out. * * @override - * @param {Array[Object]} attachments list of attachments + * @param {Array<Object>} attachments list of attachments * @param {integer} activeAttachmentID */ init: function (parent, attachments, activeAttachmentID) { diff --git a/addons/mail/static/src/js/thread.js b/addons/mail/static/src/js/thread.js index 80d4c4c8a4c..ec5ffdda1a9 100644 --- a/addons/mail/static/src/js/thread.js +++ b/addons/mail/static/src/js/thread.js @@ -130,11 +130,11 @@ var Thread = Widget.extend({ }, /** - * Modifies $element to add the 'read more/read less' functionality - * All element nodes with "data-o-mail-quote" attribute are concerned. - * All text nodes after a ""#stopSpelling" element are concerned. - * Those text nodes need to be wrapped in a span (toggle functionality). - * All consecutive elements are joined in one 'read more/read less'. + * Modifies $element to add the 'read more/read less' functionality + * All element nodes with "data-o-mail-quote" attribute are concerned. + * All text nodes after a ``#stopSpelling`` element are concerned. + * Those text nodes need to be wrapped in a span (toggle functionality). + * All consecutive elements are joined in one 'read more/read less'. */ insert_read_more: function ($element) { var self = this; |
