yuessir
/
matrix-puppeteer-line
forked from fair/matrix-puppeteer-line
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix some docstrings

This commit is contained in:
Andrew Ferrazzutti 2021-07-05 01:25:51 -04:00
parent 09cea5b43c
commit 9f0d239f4e
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
puppet/src/contentscript.js
View File

@ -193,7 +193,7 @@ class MautrixController {
* Return whether a URL points to a loaded image or not. * Return whether a URL points to a loaded image or not.
* *
* @param {string} src * @param {string} src
* @return boolean * @return {boolean}
* @private * @private
*/ */
_isLoadedImageURL(src) { _isLoadedImageURL(src) {
@ -314,7 +314,7 @@ class MautrixController {
/** /**
* @param {Element} msgSpan * @param {Element} msgSpan
* @return Promise<DOMString> * @return {Promise<DOMString>}
* @private * @private
*/ */
async _parseMessageHTML(msgSpan) { async _parseMessageHTML(msgSpan) {
@ -441,6 +441,7 @@ class MautrixController {
* Don't look for "Read" specifically, to support multiple languages. * Don't look for "Read" specifically, to support multiple languages.
* *
* @param {Element} receipt - The element containing the receipt message. * @param {Element} receipt - The element containing the receipt message.
* @return {number}
* @private * @private
*/ */
_getReceiptCount(receipt) { _getReceiptCount(receipt) {
@ -477,6 +478,8 @@ class MautrixController {
/** /**
* Check if we're waiting for a Matrix-sent message to resolve. * Check if we're waiting for a Matrix-sent message to resolve.
* @return {boolean}
* @private
*/ */
_isWaitingForOwnMessage() { _isWaitingForOwnMessage() {
return !!this.promiseOwnMsgResolve return !!this.promiseOwnMsgResolve
@ -595,6 +598,7 @@ class MautrixController {
/** /**
* @param {Element} img - The image element to get the URL and path of. * @param {Element} img - The image element to get the URL and path of.
* @return {?PathImage} - The image URL and its path, if found. * @return {?PathImage} - The image URL and its path, if found.
* @private
*/ */
_getPathImage(img) { _getPathImage(img) {
if (img && img.src.startsWith("blob:")) { if (img && img.src.startsWith("blob:")) {
@ -792,7 +796,7 @@ class MautrixController {
* Wait an additional bit of time every time an update is observed. * Wait an additional bit of time every time an update is observed.
* TODO Look (harder) for an explicit signal of when a chat is fully updated... * TODO Look (harder) for an explicit signal of when a chat is fully updated...
* *
* @returns Promise<void> * @return {Promise<void>}
*/ */
waitForMessageListStability() { waitForMessageListStability() {
// Increase this if messages get missed on sync / chat change. // Increase this if messages get missed on sync / chat change.
@ -998,6 +1002,7 @@ class MautrixController {
* @param {number} id * @param {number} id
* @param {boolean} returnClosest - If true, return the index of the nearest result on miss instead of -1. * @param {boolean} returnClosest - If true, return the index of the nearest result on miss instead of -1.
* @return {number} The index of the matched element, or -1 if not found. * @return {number} The index of the matched element, or -1 if not found.
* @private
*/ */
_findMsgsForID( _findMsgsForID(
sortedSameIDMsgs, id, returnClosest = false, sortedSameIDMsgs, id, returnClosest = false,
@ -1033,6 +1038,7 @@ class MautrixController {
* @param {SameIDMsgs[]} sortedSameIDMsgs * @param {SameIDMsgs[]} sortedSameIDMsgs
* @param {PendingMessage} msg * @param {PendingMessage} msg
* @return {SameIDMsgs} * @return {SameIDMsgs}
* @private
*/ */
_insertMsgByID(sortedSameIDMsgs, msg) { _insertMsgByID(sortedSameIDMsgs, msg) {
let i = this._findMsgsForID(sortedSameIDMsgs, msg.id, true) let i = this._findMsgsForID(sortedSameIDMsgs, msg.id, true)