Bug 1630943 - Clean up some comments. r=darktrojan
authorPaul Morris <paul@thunderbird.net>
Tue, 19 May 2020 12:56:40 +0300
changeset 39179 601e259021fbcec11fc69111f0ca04ac7b851c27
parent 39178 a440d58f09f80951264aeddebc40a804de4a3e51
child 39180 c827ec349a361a8f647744e23275fc414addf30d
push id402
push userclokep@gmail.com
push dateMon, 29 Jun 2020 20:48:04 +0000
reviewersdarktrojan
bugs1630943
Bug 1630943 - Clean up some comments. r=darktrojan
calendar/providers/caldav/CalDavCalendar.jsm
calendar/providers/caldav/modules/CalDavRequest.jsm
calendar/providers/caldav/modules/CalDavSession.jsm
calendar/resources/content/calendarCreation.js
--- a/calendar/providers/caldav/CalDavCalendar.jsm
+++ b/calendar/providers/caldav/CalDavCalendar.jsm
@@ -1663,17 +1663,17 @@ CalDavCalendar.prototype = {
       e => {
         cal.LOG(`CalDAV: Error checking server capabilities for calendar ${this.name}: ${e}`);
         this.completeCheckServerInfo(aChangeLogListener, Cr.NS_ERROR_FAILURE);
       }
     );
   },
 
   /**
-   * Locates the principal namespace. This function should soely be called
+   * Locates the principal namespace. This function should solely be called
    * from checkServerCaps to find the principal namespace.
    *
    * checkDavResourceType
    * checkServerCaps
    * findPrincipalNS                              * You are here
    * checkPrincipalsNameSpace
    * completeCheckServerInfo
    */
@@ -1710,17 +1710,17 @@ CalDavCalendar.prototype = {
         cal.LOG(`CalDAV: Failed to propstat principal namespace for calendar ${this.name}: ${e}`);
         this.completeCheckServerInfo(aChangeLogListener, Cr.NS_ERROR_FAILURE);
       }
     );
   },
 
   /**
    * Checks the principals namespace for scheduling info. This function should
-   * soely be called from findPrincipalNS
+   * solely be called from findPrincipalNS
    *
    * checkDavResourceType
    * checkServerCaps
    * findPrincipalNS
    * checkPrincipalsNameSpace                     * You are here
    * completeCheckServerInfo
    *
    * @param aNameSpaceList    List of available namespaces
--- a/calendar/providers/caldav/modules/CalDavRequest.jsm
+++ b/calendar/providers/caldav/modules/CalDavRequest.jsm
@@ -137,17 +137,16 @@ class CalDavRequestBase {
         cal.LOGverbose("CalDAV: recv: " + text);
       }
     }
 
     return this.response;
   }
 
   /** Implement nsIInterfaceRequestor */
-  /* eslint-disable-next-line valid-jsdoc */
   getInterface(aIID) {
     /**
      * Attempt to call nsIInterfaceRequestor::getInterface on the given object, and return null
      * if it fails.
      *
      * @param {Object} aObj     The object to call on.
      * @return {?*}             The requested interface object, or null.
      */
@@ -167,17 +166,16 @@ class CalDavRequestBase {
 
     // First check if the session has what we need. It may have an auth prompt implementation
     // that should go first. Ideally we should move the auth prompt to the session anyway, but
     // this is a task for another day (tm).
     return tryGetInterface(this.session) || tryGetInterface(this.calendar);
   }
 
   /** Implement nsIChannelEventSink */
-  /* eslint-disable-next-line valid-jsdoc */
   asyncOnChannelRedirect(aOldChannel, aNewChannel, aFlags, aCallback) {
     /**
      * Copy the given header from the old channel to the new one, ignoring missing headers
      *
      * @param {String} aHdr         The header to copy
      */
     function copyHeader(aHdr) {
       try {
@@ -419,17 +417,16 @@ class CalDavSimpleResponse extends CalDa
   get text() {
     if (!this._responseText) {
       this._responseText = new TextDecoder().decode(Uint8Array.from(this.result)) || "";
     }
     return this._responseText;
   }
 
   /** Implement nsIStreamLoaderObserver */
-  /* eslint-disable-next-line valid-jsdoc */
   onStreamComplete(aLoader, aContext, aStatus, aResultLength, aResult) {
     this.resultLength = aResultLength;
     this.result = aResult;
 
     this.nsirequest = aLoader.request.QueryInterface(Ci.nsIHttpChannel);
 
     if (Components.isSuccessCode(aStatus)) {
       this._onresponded(this);
--- a/calendar/providers/caldav/modules/CalDavSession.jsm
+++ b/calendar/providers/caldav/modules/CalDavSession.jsm
@@ -246,21 +246,19 @@ class CalDavSession {
    * @param {String} aSessionId    The session id, used in the password manager
    * @param {String} aName         The user-readable description of this session
    */
   constructor(aSessionId, aName) {
     this.id = aSessionId;
     this.name = aName;
 
     // There is only one right now, but for better separation this is ready for more oauth hosts
-    /* eslint-disable object-curly-newline */
     this.authAdapters = {
       "apidata.googleusercontent.com": new CalDavGoogleOAuth(aSessionId, aName),
     };
-    /* eslint-enable object-curly-newline */
   }
 
   /**
    * Implement nsIInterfaceRequestor. The base class has no extra interfaces, but a subclass of
    * the session may.
    *
    * @param {nsIIDRef} aIID       The IID of the interface being requested
    * @return {?*}                 Either this object QI'd to the IID, or null.
--- a/calendar/resources/content/calendarCreation.js
+++ b/calendar/resources/content/calendarCreation.js
@@ -157,17 +157,16 @@ function checkRequired() {
       canAdvance = eList[i].value != "";
     }
 
     if (
       canAdvance &&
       document.getElementById("calendar-uri").value &&
       curPage.pageid == "locationPage"
     ) {
-      // eslint-disable-next-line array-bracket-spacing
       let [reason] = parseUri(document.getElementById("calendar-uri").value);
       canAdvance = reason == errorConstants.SUCCESS;
       setNotification(reason);
     } else {
       gNotification.notificationbox.removeAllNotifications();
     }
     document.querySelector("wizard").canAdvance = canAdvance;
   }