Bug 1801529 - eslint-plugin-jsdoc fixes for mailnews/. rs=me

mailnews/db/gloda/modules/GlodaIndexer.sys.mjs

@@ -115,7 +115,6 @@ IndexingJob.prototype = {
  *   notification promptly at the end of our inactive period, we believe the
  *   system is not heavily loaded.  If we do not get notified promptly, we
  *   assume there is other stuff going on and back off.
- *
  */
 export var GlodaIndexer = {
   /**

mailnews/extensions/newsblog/Feed.sys.mjs

@@ -511,8 +511,8 @@ Feed.prototype = {
    * feed. There's a delay - invalid items are kept around for a set time
    * before being purged.
    *
-   * @param {Boolean} aDeleteFeed - is the feed being deleted (bypasses
-   *                                the delay time).
+   * @param {boolean} aDeleteFeed - is the feed being deleted (bypasses
+   *   the delay time).
    * @returns {void}
    */
   removeInvalidItems(aDeleteFeed) {

mailnews/extensions/newsblog/FeedItem.sys.mjs

@@ -330,7 +330,7 @@ FeedItem.prototype = {
    * @param  {string} headerName          - Name of the header.
    * @param  {string[]} headerItemsArray  - An Array of strings to concatenate.
    *
-   * @returns {String} - The header string.
+   * @returns {string} - The header string.
    */
   createHeaderStrFromArray(headerName, headerItemsArray) {
     let headerStr = "";

mailnews/extensions/newsblog/FeedParser.sys.mjs

@@ -1192,7 +1192,7 @@ FeedParser.prototype = {
    * Return a cleaned up author name value.
    *
    * @param {string} authorString - A string.
-   * @returns {String} - A clean string value.
+   * @returns {string} - A clean string value.
    */
   cleanAuthorName(authorString) {
     if (!authorString) {
@@ -1220,7 +1220,7 @@ FeedParser.prototype = {
    * a space and unprintable ascii is removed.
    *
    * @param {Node} node - A DOM node.
-   * @returns {String} - A clean string value or null.
+   * @returns {string} - A clean string value or null.
    */
   getNodeValue(node) {
     let nodeValue = this.getNodeValueRaw(node);
@@ -1238,7 +1238,7 @@ FeedParser.prototype = {
    * that are multiline and formatted, such as content or description tags.
    *
    * @param {Node} node - A DOM node.
-   * @returns {String} - A clean string value or null.
+   * @returns {string} - A clean string value or null.
    */
   getNodeValueFormatted(node) {
     const nodeValue = this.getNodeValueRaw(node);
@@ -1254,7 +1254,7 @@ FeedParser.prototype = {
    * appropriate.
    *
    * @param {Node} node - A DOM node.
-   * @returns {String} - A string value or null.
+   * @returns {string} - A string value or null.
    */
   getNodeValueRaw(node) {
     if (node && node.textContent) {
@@ -1300,7 +1300,7 @@ FeedParser.prototype = {
    *
    * @param {Element} element - DOM element to search.
    * @param {string} namespace - Namespace of the search tag.
-   * @param {String} tagName - Tag to search for.
+   * @param {string} tagName - Tag to search for.
    * @returns {Element|null} - Matching element, or null.
    */
   childByTagNameNS(element, namespace, tagName) {
@@ -1317,7 +1317,7 @@ FeedParser.prototype = {
    * particularly to prevent data: uris, javascript, and other spoofing.
    *
    * @param {string} link - An intended http url string.
-   * @returns {String} - A clean string starting with http, ftp or magnet,
+   * @returns {string} - A clean string starting with http, ftp or magnet,
    *                         else null.
    */
   validLink(link) {
@@ -1339,7 +1339,7 @@ FeedParser.prototype = {
    * @param {NodeList} linkElements - the nodelist of <links> to search in.
    * @param {string} baseURI - the url to use when resolving relative
    *                                   links to absolute values.
-   * @returns {String} or null       - absolute url for a <link>, or null if the
+   * @returns {string} or null       - absolute url for a <link>, or null if the
    *                                   rel type is not found.
    */
   findAtomLink(linkRel, linkElements, baseURI) {
@@ -1374,7 +1374,7 @@ FeedParser.prototype = {
    * http://web.resource.org/rss/1.0/modules/syndication/
    *
    * @param {Feed} aFeed - the feed object.
-   * @param {Node | String} aChannel  - dom node for the <channel>.
+   * @param {Node | string} aChannel  - dom node for the <channel>.
    * @returns {void}
    */
   findSyUpdateTags(aFeed, aChannel) {
@@ -1433,7 +1433,7 @@ FeedParser.prototype = {
    * Remove unprintable ascii, particularly CR/LF, for non formatted tag values.
    *
    * @param {string} s - String to clean.
-   * @returns {String} - Cleaned string.
+   * @returns {string} - Cleaned string.
    */
   removeUnprintableASCII(s) {
     /* eslint-disable-next-line no-control-regex */
@@ -1444,7 +1444,7 @@ FeedParser.prototype = {
    * Remove unprintable ascii, except CR/LF/TAB, for formatted tag values.
    *
    * @param {string} s - String to clean.
-   * @returns {String} - Cleaned string.
+   * @returns {string} - Cleaned string.
    */
   removeUnprintableASCIIexCRLFTAB(s) {
     /* eslint-disable-next-line no-control-regex */

mailnews/extensions/newsblog/FeedUtils.sys.mjs

@@ -130,7 +130,7 @@ export var FeedUtils = {
   /**
    * Create rss account.
    *
-   * @param {String} aName - Optional account name to override default.
+   * @param {string} aName - Optional account name to override default.
    * @returns {nsIMsgAccount} - The creaged account.
    */
   createRssAccount(aName) {
@@ -187,7 +187,7 @@ export var FeedUtils = {
    *
    * @param {string} aUrl - The url.
    * @param {nsIMsgIncomingServer} aServer - Account server.
-   * @returns {Boolean} - true if exists else false.
+   * @returns {boolean} - true if exists else false.
    */
   feedAlreadyExists(aUrl, aServer) {
     const ds = this.getSubscriptionsDS(aServer);
@@ -211,7 +211,7 @@ export var FeedUtils = {
    *
    * @param {nsIMsgFolder} aFolder - The folder.
    * @param {nsIUrlListener} aUrlListener - Feed url.
-   * @param {Boolean} aIsBiff - true if biff, false if manual get.
+   * @param {boolean} aIsBiff - true if biff, false if manual get.
    * @param {nsIDOMWindow} aMsgWindow - The window.
    *
    * @returns {Promise<void>} When all feeds downloading have been set off.
@@ -426,7 +426,7 @@ export var FeedUtils = {
   /**
    * Subscribe a new feed url.
    *
-   * @param {String} aUrl - Feed url.
+   * @param {string} aUrl - Feed url.
    * @param {nsIMsgFolder} aFolder - Folder.
    *
    * @returns {void}
@@ -488,7 +488,7 @@ export var FeedUtils = {
    *
    * @param {nsIMsgFolder} aFolder - Folder or account folder (server).
    * @param {boolean} aPause - To pause or not to pause.
-   * @param {Boolean} aBiffNow - If aPause is false, and aBiffNow is true
+   * @param {boolean} aBiffNow - If aPause is false, and aBiffNow is true
    *                                     do the biff immediately.
    * @returns {void}
    */
@@ -595,7 +595,7 @@ export var FeedUtils = {
    * @param {Feed} aFeed - The feed object.
    * @param {string} aNewUrl - New url.
    *
-   * @returns {Boolean} - true if successful, else false.
+   * @returns {boolean} - true if successful, else false.
    */
   changeUrlForFeed(aFeed, aNewUrl) {
     if (!aFeed || !aFeed.folder || !aNewUrl) {
@@ -640,7 +640,7 @@ export var FeedUtils = {
    *
    * @param {nsIMsgDBHdr} aMsgHdr - The message.
    *
-   * @returns {Boolean} - true if message is a feed, false if not.
+   * @returns {boolean} - true if message is a feed, false if not.
    */
   isFeedMessage(aMsgHdr) {
     return Boolean(
@@ -656,7 +656,7 @@ export var FeedUtils = {
    *
    * @param {nsIMsgFolder} aFolder - The folder.
    *
-   * @returns {Boolean} - true if folder's server.type is in FEED_ACCOUNT_TYPES,
+   * @returns {boolean} - true if folder's server.type is in FEED_ACCOUNT_TYPES,
    *                      false if not.
    */
   isFeedFolder(aFolder) {
@@ -671,7 +671,7 @@ export var FeedUtils = {
    *
    * @param {nsIMsgFolder} aFolder - The folder.
    *
-   * @returns {String}[]           - Array of urls, or null if none.
+   * @returns {string}[]           - Array of urls, or null if none.
    */
   getFeedUrlsInFolder(aFolder) {
     if (
@@ -718,7 +718,7 @@ export var FeedUtils = {
    * @param {boolean} aReparse - Reparse if true.
    * @param {nsIUrlListener} aUrlListener - Object implementing nsIUrlListener.
    *
-   * @returns {Boolean} - true if msgDb is available, else false
+   * @returns {boolean} - true if msgDb is available, else false
    */
   isMsgDatabaseOpenable(aFolder, aReparse, aUrlListener) {
     let msgDb;
@@ -812,7 +812,7 @@ export var FeedUtils = {
    * @param {nsIMsgFolder} aFolder - Folder.
    * @param {string} aUrl - Url key (feed url or folder URI).
    *
-   * @returns {String} aValue        - The value.
+   * @returns {string} aValue - The value.
    */
   getStatus(aFolder, aUrl) {
     if (!aFolder || !aUrl) {
@@ -918,6 +918,7 @@ export var FeedUtils = {
 
     /**
      * Convert a Blob to data URL.
+     *
      * @param {Blob} blob - Blob to convert.
      * @returns {string} data URL.
      */
@@ -944,6 +945,7 @@ export var FeedUtils = {
 
     /**
      * Try getting favicon from url.
+     *
      * @param {string} faviconUrl - The favicon url.
      * @returns {Blob} - Existing favicon.
      */
@@ -960,6 +962,7 @@ export var FeedUtils = {
 
     /**
      * Try getting favicon from the a html page.
+     *
      * @param {string} page - The page url to check.
      * @returns {Blob} - Found favicon.
      */
@@ -1038,7 +1041,7 @@ export var FeedUtils = {
    * @param {nsIMsgFolder} aFolder - The folder, new if rename or target of
    *                                      move/copy folder (new parent).
    * @param {nsIMsgFolder} aOrigFolder - Original folder.
-   * @param {String} aAction - "move" or "copy" or "rename".
+   * @param {string} aAction - "move" or "copy" or "rename".
    *
    * @returns {void}
    */
@@ -1098,7 +1101,7 @@ export var FeedUtils = {
    * @param {nsIMsgFolder} aFolder - New folder.
    * @param {nsIMsgFolder} aOrigFolder - Original folder.
    * @param {string} aNewAncestorURI - For subfolders, ancestor new folder.
-   * @param {String} aOrigAncestorURI - For subfolders, ancestor original folder.
+   * @param {string} aOrigAncestorURI - For subfolders, ancestor original folder.
    *
    * @returns {void}
    */
@@ -1173,12 +1176,12 @@ export var FeedUtils = {
    * is not strictly correct.
    *
    * @param {nsIMsgFolder} aParentFolder - Parent folder.
-   * @param {String}       aProposedName - Proposed name.
-   * @param {String}       aDefaultName  - Default name if proposed sanitizes to
+   * @param {string}       aProposedName - Proposed name.
+   * @param {string}       aDefaultName  - Default name if proposed sanitizes to
    *                                       blank, caller ensures sane value.
-   * @param {Boolean}      aUnique       - If true, return a unique indexed name.
+   * @param {boolean}      aUnique       - If true, return a unique indexed name.
    *
-   * @returns {String} - Sanitized unique name.
+   * @returns {string} - Sanitized unique name.
    */
   getSanitizedFolderName(aParentFolder, aProposedName, aDefaultName, aUnique) {
     // Clean up the name for the strictest fs (fat) and to ensure portability.
@@ -1441,7 +1444,7 @@ export var FeedUtils = {
    *
    * @param {string} feedURL - URL of the feed.
    * @param {nsIMsgIncomingServer} server - Server holding the subscription.
-   * @param {String} attrName - Name of attribute to fetch.
+   * @param {string} attrName - Name of attribute to fetch.
    * @param {undefined} defaultValue - Value to return if not found.
    *
    * @returns {undefined} - the fetched value (defaultValue if the
@@ -1463,7 +1466,7 @@ export var FeedUtils = {
    *
    * @param {string} feedURL - URL of the feed.
    * @param {nsIMsgIncomingServer} server - server holding subscription.
-   * @param {String} attrName - Name of attribute to fetch.
+   * @param {string} attrName - Name of attribute to fetch.
    * @param {undefined} value - Value to store.
    *
    * @returns {void}
@@ -1730,7 +1733,7 @@ export var FeedUtils = {
    *
    * @param {nsIMsgFolder} aFolder - The folder.
    *
-   * @returns {Boolean} - true if folder is Trash else false.
+   * @returns {boolean} - true if folder is Trash else false.
    */
   isInTrash(aFolder) {
     const trashFolder = aFolder.rootFolder.getFolderWithFlags(
@@ -1752,7 +1755,7 @@ export var FeedUtils = {
    *
    * @param {nsIMsgFolder} aFolder - The folder.
    *
-   * @returns {String} prettyName or null  - Name or null if not a disk folder.
+   * @returns {string} prettyName or null  - Name or null if not a disk folder.
    */
   getFolderPrettyPath(aFolder) {
     let msgFolder = lazy.MailUtils.getExistingFolder(aFolder.URI);
@@ -1787,7 +1790,7 @@ export var FeedUtils = {
    *
    * @param {string} aDate - Date string.
    *
-   * @returns {Boolean} - true if passes regex test, false if not.
+   * @returns {boolean} - true if passes regex test, false if not.
    */
   isValidRFC822Date(aDate) {
     const FZ_RFC822_RE =
@@ -1805,7 +1808,7 @@ export var FeedUtils = {
    * @param {string} aDateString - Optional date string; if null or invalid
    *                               date, get the current datetime.
    *
-   * @returns {String} - An rfc5322 date string.
+   * @returns {string} - An rfc5322 date string.
    */
   getValidRFC5322Date(aDateString) {
     let d = new Date(aDateString || new Date().getTime());
@@ -1866,7 +1869,7 @@ export var FeedUtils = {
      * @param {Feed} feed - The Feed object, or a synthetic object that must
      *                      contain members {nsIMsgFolder folder, String url}.
      * @param {Integer} aErrorCode - The resolution code, a kNewsBlog* value.
-     * @param {Boolean} aDisable - If true, disable/pause the feed.
+     * @param {boolean} aDisable - If true, disable/pause the feed.
      *
      * @returns {void}
      */

mailnews/extensions/newsblog/feed-subscriptions.js

@@ -784,7 +784,7 @@ var FeedSubscriptions = {
    * {nsIMsgFolder} newFolder - if not null (default) the new folder,
    *                            for add or rename.
    *
-   * @returns {Boolean} found - true if found, false if not.
+   * @returns {boolean} found - true if found, false if not.
    */
   selectFolder(aFolder, aParms) {
     const folderURI = aFolder.URI;
@@ -992,7 +992,7 @@ var FeedSubscriptions = {
    * @param {Feed} aFeed - The feed to find.
    * @param {Integer} aParentIndex - Index to start the folder search.
    *
-   * @returns {Boolean} found - true if found, false if not.
+   * @returns {boolean} found - true if found, false if not.
    */
   selectFeed(aFeed, aParentIndex) {
     let folder = aFeed.folder;
@@ -1598,17 +1598,17 @@ var FeedSubscriptions = {
    * though the url were entered manually.  This allows a user to see the dnd
    * url better in case of errors.
    *
-   * @param {String} aFeedLocation - the feed url; get the url from the
+   * @param {string} aFeedLocation - the feed url; get the url from the
    *                                     input field if null.
    * @param {nsIMsgFolder} aFolder - folder to subscribe, current selected
    *                                     folder if null.
-   * @param {Boolean} aParse - if true (default) parse and download
+   * @param {boolean} aParse - if true (default) parse and download
    *                                     the feed's articles.
-   * @param {Object} aParams - additional params.
+   * @param {object} aParams - additional params.
    * @param {Integer} aMode - action mode (default is kSubscribeMode)
    *                                     of the add.
    *
-   * @returns {Boolean} success        - true if edit checks passed and an
+   * @returns {boolean} success        - true if edit checks passed and an
    *                                     async download has been initiated.
    */
   addFeed(aFeedLocation, aFolder, aParse, aParams, aMode) {
@@ -1776,7 +1776,7 @@ var FeedSubscriptions = {
    *
    * @param {Integer} aOldFeedIndex - Index in tree of target feed item.
    * @param {Integer} aNewParentIndex - Index in tree of target parent folder item.
-   * @param {String} aMoveCopy - Either "move" or "copy".
+   * @param {string} aMoveCopy - Either "move" or "copy".
    *
    * @returns {void}
    */
@@ -2481,7 +2481,7 @@ var FeedSubscriptions = {
   /**
    * Export feeds as opml file Save As filepicker function.
    *
-   * @param {Boolean} aList - If true, exporting as list; if false (default)
+   * @param {boolean} aList - If true, exporting as list; if false (default)
    *                          exporting feeds in folder structure - used for title.
    * @returns {Promise} nsIFile or null.
    */
@@ -2811,7 +2811,7 @@ var FeedSubscriptions = {
    * @param {nsIMsgIncomingServer} aServer - The account server.
    * @param {Function} aCallback - Callback function.
    *
-   * @returns {Boolean} - false if error.
+   * @returns {boolean} - false if error.
    */
   async importOPMLFile(aFile, aFileUrl, aServer, aCallback) {
     if (aServer && aServer instanceof Ci.nsIMsgIncomingServer) {

mailnews/extensions/newsblog/newsblogOverlay.js

@@ -72,7 +72,7 @@ var FeedMessageHandler = {
    * @param {nsIMsgDBHdr} aMsgHdr - The message.
    * @param {boolean} aToggle - true if in toggle mode, false otherwise.
    *
-   * @returns {Boolean} - true if summary is to be displayed, false if web page.
+   * @returns {boolean} - true if summary is to be displayed, false if web page.
    */
   shouldShowSummary(aMsgHdr, aToggle) {
     // Not a feed message, always show summary (the message).
@@ -172,7 +172,7 @@ var FeedMessageHandler = {
    * is not streamed.
    *
    * @param {nsIMsgDBHdr} aMessageHdr - The message.
-   * @param {Object} aWhere - name value=true pair, where name is in:
+   * @param {object} aWhere - name value=true pair, where name is in:
    *                                    'messagepane', 'browser', 'tab', 'window'.
    * @returns {void}
    */
@@ -228,7 +228,7 @@ var FeedMessageHandler = {
    * know if the message is a feed message.
    *
    * @param {nsIMsgDBHdr} aMsgHdr - The message.
-   * @param {Boolean} aShowSummary - true if summary is to be displayed,
+   * @param {boolean} aShowSummary - true if summary is to be displayed,
    *                                 false if web page.
    * @returns {void}
    */

mailnews/extensions/smime/certFetchingStatus.js

@@ -118,6 +118,7 @@ async function getPassword() {
 
 /**
  * Checks if the LDAP connection can be bound.
+ *
  * @implements {nsILDAPMessageListener}
  */
 class BindListener {
@@ -143,6 +144,7 @@ class BindListener {
 
 /**
  * LDAPMessageListener.
+ *
  * @implements {nsILDAPMessageListener}
  */
 class LDAPMessageListener {

mailnews/imap/src/ImapChannel.sys.mjs

@@ -115,6 +115,7 @@ export class ImapChannel extends MailChannel {
 
   /**
    * Get readonly URI.
+   *
    * @see nsIChannel
    */
   get URI() {

mailnews/imap/src/ImapIncomingServer.sys.mjs

@@ -14,7 +14,7 @@ ChromeUtils.defineESModuleGetters(lazy, {
 });
 
 /**
- * @extends {MsgIncomingServer}
+ * @augments {MsgIncomingServer}
  * @implements {nsIImapServerSink}
  * @implements {nsIImapIncomingServer}
  * @implements {nsIMsgIncomingServer}

mailnews/local/src/Pop3Client.sys.mjs

@@ -268,6 +268,7 @@ export class Pop3Client {
 
   /**
    * Send `QUIT` request to the server.
+   *
    * @param {Function} nextAction - Callback function after QUIT response.
    */
   async quit(nextAction) {
@@ -1663,6 +1664,7 @@ export class Pop3Client {
 
   /**
    * Save popstate.dat when necessary, send QUIT.
+   *
    * @param {nsresult} status - Indicate if the last action succeeded.
    */
   _actionDone = async (status = Cr.NS_OK) => {
@@ -1703,6 +1705,7 @@ export class Pop3Client {
 
   /**
    * Notify listeners, close the socket and rest states.
+   *
    * @param {nsresult} status - Indicate if the last action succeeded.
    */
   _cleanUp = status => {

mailnews/mime/test/unit/test_openpgp_decrypt.js

@@ -38,6 +38,7 @@ const contents = "Sundays are nothing without callaloo.";
 /**
  * This implements some of the methods of openpgpSink so we can
  * intercept and record the calls to updateSecurityStatus().
+ *
  * @implements {nsIMsgOpenPGPSink}
  */
 const openpgpSink = {

mailnews/news/src/NntpClient.sys.mjs

@@ -566,6 +566,7 @@ export class NntpClient {
 
   /**
    * Send `NEWGROUPS` request to the server.
+   *
    * @see rfc3977#section-7.3
    */
   _actionNewgroups = () => {
@@ -765,6 +766,7 @@ export class NntpClient {
 
   /**
    * Send `ARTICLE` request to the server.
+   *
    * @see {@link https://www.rfc-editor.org/rfc/rfc3977#section-6.2.1|RFC 3977 §6.2.1}
    */
   _actionArticle = () => {

mailnews/test/fakeserver/EwsServer.sys.mjs

@@ -74,6 +74,7 @@ const SYNC_FOLDER_HIERARCHY_RESPONSE_BASE = `${EWS_SOAP_HEAD}
 export class RemoteFolder {
   /**
    * The unique EWS identifier for this folder.
+   *
    * @type {string}
    * @public
    */
@@ -82,6 +83,7 @@ export class RemoteFolder {
   /**
    * An optional distinguished ID if this is a special folder (e.g. Inbox, root
    * folder, etc.).
+   *
    * @type {?string}
    * @public
    */
@@ -89,6 +91,7 @@ export class RemoteFolder {
 
   /**
    * The display name for the folder. Defaults to its ID.
+   *
    * @type {string}
    * @public
    */
@@ -97,6 +100,7 @@ export class RemoteFolder {
   /**
    * The EWS identifier for the parent of this folder. Only the root folder
    * should be allowed to not have a parent.
+   *
    * @type {?string}
    * @public
    */
@@ -124,12 +128,14 @@ export class MockEWSServer {
   #mHttpServer;
   /**
    * The folders registered on this EWS server.
+   *
    * @type {RemoteFolder[]}
    */
   #mFolders = [];
 
   /**
    * A mapping from EWS identifier to folder specification.
+   *
    * @type {Map<string, RemoteFolder>}
    */
   #mIdToFolder = new Map();
@@ -137,18 +143,21 @@ export class MockEWSServer {
   /**
    * A mapping from EWS distinguished identifier to folder specification. This
    * only includes folders for which a distinguished identifier is specified.
+   *
    * @type {Map<string, RemoteFolder>}
    */
   #mDistinguishedIdToFolder = new Map();
 
   /**
    * The parser to use for parsing XML documents.
+   *
    * @type {DOMParser}
    */
   #mParser;
 
   /**
    * The serializer to use for generating XML documents.
+   *
    * @type {XMLSerializer}
    */
   #mSerializer;