XML comment additions to source

Author: Andrew Omondi

ConsoleApplication/Helpers/PageIterator.cs

@@ -39,13 +39,28 @@ public class PageIterator
     {
         private IMailFolderDeltaCollectionPage mailfolders;
         private readonly Action<MailFolder> callback;
+
+        /// <summary>
+        /// String token used for making request to Graph API to check 
+        /// for changes in the collection
+        /// </summary>
         public string DeltaLink { get; private set; }
 
+        /// <summary>
+        /// Constructor for the PageIterator
+        /// <param name="mailFolders">Instance of <see cref="IMailFolderDeltaCollectionPage"/> that holds
+        /// the collection mail folders to be processed.</param>
+        /// <param name="callback">Call back to process each item in collection.</param>
+        /// </summary>
         public PageIterator(IMailFolderDeltaCollectionPage mailFolders, Action<MailFolder> callback)
         {
             this.mailfolders = mailFolders;
             this.callback = callback;
         }
+
+        /// <summary>
+        /// Iterate through the mailfolders collection and process each item with the provided callback.
+        /// </summary>
         public async Task Iterate()
         {
             var more = true;
@@ -55,13 +70,16 @@ public async Task Iterate()
                 {
                     callback(item);
                 }
+
                 if (mailfolders.NextPageRequest != null)
                 {
                     this.mailfolders = await mailfolders.NextPageRequest.GetAsync();
-                } else
+                }
+                else
                 {
                     more = false;
                 }
+
                 if (this.mailfolders.AdditionalData.ContainsKey(Constants.DeltaLinkFeedAnnotation))
                 {
                     DeltaLink = this.mailfolders.AdditionalData[Constants.DeltaLinkFeedAnnotation] as string;

ConsoleApplication/Program.cs

@@ -55,7 +55,8 @@ private static void Main()
                     new string[] { Constants.DefaultScope });
 
             // Start watching mail folders
-            try {
+            try
+            {
                 Task.Run(() => WatchMailFolders(appConfiguration.PullIntervalSec)).Wait();
             }
             catch (MsalServiceException mse)
@@ -130,16 +131,21 @@ public static async Task WatchMailFolders(int pullIntervalSec)
             }
         }
 
+        /// <summary>
+        /// Method for handling exceptions thrown by the MSAL library.
+        /// </summary>
+        /// <param name="mse">Intance of an excpetion of the type <see cref="MsalServiceException"/>> </param>
+        /// <returns></returns>
         private static void ProcessMsalException(MsalServiceException mse)
         {
             switch (mse.ErrorCode)
             {
                 case MsalServiceException.InvalidAuthority:
-                // What happens:   When the library attempts to discover the authority and get the endpoints it
-                // needs to acquire a token, it got an un-authorize HTTP code or an unexpected response
-                // Remediation:
-                // Check that the authority configured for the application, or passed on some overrides
-                // of token acquisition tokens supporting authority override is correct
+                    // What happens:   When the library attempts to discover the authority and get the endpoints it
+                    // needs to acquire a token, it got an un-authorize HTTP code or an unexpected response
+                    // Remediation:
+                    // Check that the authority configured for the application, or passed on some overrides
+                    // of token acquisition tokens supporting authority override is correct
                 case "unauthorized_client":
                     // For instance: AADSTS700016: Application with identifier '{clientId}' was not found in the directory '{domain}'.
                     // This can happen if the application has not been installed by the administrator of the tenant or consented to by any user in the tenant.