Bug 1801529 - Fix jsdocs in PhishingDetector.sys.mjs and SmartMailboxUtils.sys.mjs. r=me

--HG--
extra : rebase_source : 857da578a43873216c3e851ea2f8580a85da6e85

mail/modules/PhishingDetector.sys.mjs

@@ -149,7 +149,7 @@ export const PhishingDetector = new (class PhishingDetector {
    * Opens the default browser to a page where the user can submit the given url
    * as a phish.
    *
-   * @param aPhishingURL the url we want to report back as a phishing attack
+   * @param {string} aPhishingURL - The url we want to report back as a phishing attack.
    */
   reportPhishingURL(aPhishingURL) {
     let reportUrl = Services.urlFormatter.formatURLPref(
@@ -170,12 +170,9 @@ export const PhishingDetector = new (class PhishingDetector {
    * The warning prompt includes the unobscured host name of the http(s) url the
    * user clicked on.
    *
-   * @param {DOMWindow} win
-   *   The window the message is being displayed within.
-   * @param {string} aUrl
-   *   The url of the message
-   * @param {string} aLinkText
-   *   User visible link text associated with the link
+   * @param {DOMWindow} win - The window the message is being displayed within.
+   * @param {string} aUrl - The url of the message
+   * @param {string} aLinkText - User visible link text associated with the link
    * @returns {number}
    *   0 if the URL implied by aLinkText should be used instead.
    *   1 if the request should be blocked.

mail/modules/SmartMailboxUtils.sys.mjs

@@ -34,6 +34,7 @@ class SmartMailbox {
 
   /**
    * Returns the server of the smart mailbox account.
+   *
    * @returns {nsIMsgIncomingServer}
    */
   get server() {
@@ -42,6 +43,7 @@ class SmartMailbox {
 
   /**
    * Returns the smart mailbox account.
+   *
    * @returns {nsIMsgAccount}
    */
   get account() {
@@ -50,6 +52,7 @@ class SmartMailbox {
 
   /**
    * Returns the root folder of the smart mailbox account.
+   *
    * @returns {nsIMsgFolder}
    */
   get rootFolder() {
@@ -58,6 +61,7 @@ class SmartMailbox {
 
   /**
    * Returns the tags folder of the smart mailbox account.
+   *
    * @returns {nsIMsgFolder}
    */
   get tagsFolder() {
@@ -286,6 +290,7 @@ export const SmartMailboxUtils = {
 
   /**
    * Returns a clone of the folder type array defined at the top of this module.
+   *
    * @returns {object[]}
    */
   getFolderTypes() {