[IMP] mail: update documentation of params in thread.xml templates

Some parameters in the templates were not documented, which is now
the case with this commit.
This commit is contained in:
Alexandre Kühn
2018-07-19 13:58:33 +02:00
parent 4925d53562
commit a6f6bbb46f
+60 -2
View File
@@ -3,6 +3,14 @@
<!--
@param {mail.model.AbstractMessage[]} messages
@param {Object} options
@param {boolean} [options.displayEmptyThread]
@param {boolean} [options.displayLoadMore]
@param {boolean} [options.displayNoMatchFound]
@param {integer} [options.displayOrder] 1 or -1
@param {Object} ORDER
@param {integer} ORDER.ASC=1
@param {integer} ORDER.DESC=-1
-->
<t t-name="mail.widget.Thread">
<t t-if="messages.length">
@@ -21,7 +29,9 @@
</div>
</t>
<!--
@param {mail.DocumentViewer} widget
-->
<t t-name="DocumentViewer.Content">
<div class="o_viewer_content">
<div class="o_viewer-header">
@@ -63,6 +73,9 @@
</div>
</t>
<!--
@param {mail.DocumentViewer} widget
-->
<t t-name="DocumentViewer">
<div class="modal o_modal_fullscreen" tabindex="-1" data-keyboard="false" role="dialog">
<t t-call="DocumentViewer.Content"/>
@@ -77,6 +90,10 @@
</t>
</div>
</t>
<!--
@param {string} src
-->
<t t-name="PrintImage">
<html>
<head>
@@ -99,7 +116,8 @@
<!--
When a thread is empty
@param {mail.widget.Thread} widget
@param {Object} options
@param {string|integer} options.threadID
-->
<div t-name="mail.widget.Thread.Empty" class="o_mail_no_content">
<t t-if="options.threadID === 'mailbox_inbox'">
@@ -118,6 +136,8 @@
<!--
@param {mail.model.AbstractMessage[]} messages
@param {string|integer} [options.messagesSeparatorPosition] 'top' or
message ID, the separator is placed just after this message.
-->
<t t-name="mail.widget.Thread.Content">
<t t-if="options.messagesSeparatorPosition == 'top'" t-call="mail.MessagesSeparator"/>
@@ -135,7 +155,20 @@
</t>
<!--
@param {string} dateFormat
@param {mail.model.AbstractMessage} message
@param {Object} options
@param {boolean} [options.displayAvatars]
@param {boolean} [options.displayDocumentLinks]
@param {boolean} [options.displayEmailIcons]
@param {boolean} [options.displayMarkAsRead]
@param {boolean} [options.displayReplyIcons]
@param {boolean} [options.displayStars]
@param {boolean} [options.displaySubjectsOnMessages]
@param {string|integer} [options.messagesSeparatorPosition] 'top' or
message ID, the separator is placed just after this message.
@param {integer} [options.selectedMessageID]
@param {string|integer} [options.threadID]
-->
<t t-name="mail.widget.Thread.Message">
<div t-att-class="'o_thread_message' + (message.getID() === options.selectedMessageID ? 'o_thread_selected_message ' : ' ') + (message.isDiscussion() or message.isNotification() ? ' o_mail_discussion' : ' o_mail_not_discussion')" t-att-data-message-id="message.getID()">
@@ -287,6 +320,9 @@
</div>
</t>
<!--
@param {mail.model.Message} message
-->
<t t-name="mail.widget.Thread.MessageTracking">
<ul class="o_mail_thread_message_tracking">
<t t-foreach='message.getTrackingValues()' t-as='value'>
@@ -304,6 +340,9 @@
</ul>
</t>
<!--
@param {Array} attachments
-->
<t t-name="mail.composer.Attachments">
<div t-if="attachments.length > 0" class="o_attachments o_attachments_list">
<t t-foreach="attachments" t-as='attachment'>
@@ -314,6 +353,12 @@
</div>
</t>
<!--
@param {Object} attachment
@param {integer} attachment.id
@param {string} attachment.name
@param {string} attachment.url
-->
<t t-name="mail.AttachmentPreview">
<div class="o_attachment" t-att-title="attachment.name">
<div class="o_attachment_wrap">
@@ -330,6 +375,15 @@
</div>
</t>
<!--
@param {Object} attachment
@param {string} attachment.filename
@param {integer} attachment.id
@param {string} [attachment.mimetype]
@param {string} attachment.name
@param {boolean} attachment.upload
@param {string} attachment.url
-->
<t t-name="mail.Attachment">
<t t-set="type" t-value="attachment.mimetype and attachment.mimetype.split('/').shift()"/>
<div t-attf-class="o_attachment #{ editable ? 'o_attachment_editable' : '' } #{attachment.upload ? 'o_attachment_uploading' : ''}" t-att-title="attachment.name">
@@ -370,6 +424,10 @@
</div>
</t>
<!--
@param {Object} options
@param {boolean} [options.loadMoreOnScroll]
-->
<t t-name="mail.widget.Thread.LoadMore">
<div class="o_thread_show_more">
<t t-if="options.loadMoreOnScroll">