iartamonov/mautrix-telegram
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Update jsdocs

Browse Source
This commit is contained in:
Tulir Asokan
2017-11-30 17:53:25 +02:00
parent 9f7e816b36
commit 4012774dd6
1 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/formatter.js
+4 -6
View File
@@ -16,8 +16,8 @@
/**
* Utility functions to convert between Telegram and Matrix (HTML) formatting.
*
* WARNING: This module contains headache-causing regular expressions and other duct tape.
* <br><br>
* <b>WARNING: This module contains headache-causing regular expressions and other duct tape.</b>
*
* @module formatter
*/
@@ -38,10 +38,8 @@ function addTag(tags, entity, tag, attrs, priority = 0) {
/**
* Convert a Telegram entity-formatted message to a Matrix HTML-formatted message.
*
* WARNING: I am not responsible for possible severe headaches caused by reading any part of this function.
* While there are a few explaining comments, I haven't even tried to figure out why it works.
* The tag priorities are especially non-understandable. You have been warned.
* <br><br>
* <b>WARNING: I am not responsible for possible severe headaches caused by reading any part of this function.</b>
*
* @param {string} message The plaintext message.
* @param {Array} entities The Telegram formatting entities.