Add xml Documentation

Author: Роман Воронцов

Documentation/en-EN/WhatsApp/ChatApi.WA.Account/Operations/Expiry.md

@@ -1,4 +1,4 @@
-# Updates the QR code after its expired
+# Updates the QR code after its expired.
 **<span style="color:green">Implementation notes</span>**<br/>
 This method is available in both synchronous and asynchronous implementations
 

Documentation/en-EN/WhatsApp/ChatApi.WA.Dialogs/UIOperations/ReadChat.md

@@ -12,7 +12,7 @@ This method is available in both synchronous and asynchronous implementations.
 ## Response
 | `Parameter`           | `Description`                                           | `The data type of the parameter` | 
 |:---------------------:|:--------------------------------------------------------|:--------------------------------:|
-| `Read`                | The status of the request.                              | `Boolean`                        |
+| `Read`                | Message readability indicator                           | `Boolean`                        |
 | `ChatId`              | Unique ID of the dialog.                                | `String`                         |
 | `Message`             | Dialog reading status                                   | `String`                         |
 

Documentation/en-EN/WhatsApp/ChatApi.WA.Dialogs/UIOperations/SendTypingStatus.md

@@ -48,8 +48,8 @@ namespace ChatApiClient
 
             var chatApiResponse = userInterfaceOperations.SendTypingStatus(request);
             if (!chatApiResponse.IsSuccess) throw chatApiResponse.Exception!;
+            
             var response = chatApiResponse.GetResult();
-
             Console.WriteLine(response?.PrintMembers());
         }
     }

Src/ChatApi.Core/Models/ChatApiStatusOperation.cs

@@ -2,7 +2,6 @@
 
 namespace ChatApi.Core.Models
 {
-    //Need description:chatApi
     /// <summary/>
     public enum ChatApiStatusOperation : byte
     {

Src/ChatApi.Core/Models/Interfaces/IErrorResponse.cs

@@ -2,7 +2,6 @@
 
 namespace ChatApi.Core.Models.Interfaces
 {
-    //Need description:chatApi
     /// <summary/>
     public interface IErrorResponse
     {

Src/ChatApi.Core/Models/Interfaces/IOperationResult.cs

@@ -2,12 +2,11 @@
 
 namespace ChatApi.Core.Models.Interfaces
 {
-    //Need description:chatApi
-    /// <summary/>
+    /// <inheritdoc cref="Result"/>
     public interface IOperationResult
     {
         /// <summary>
-        /// 
+        ///     The status of the request.
         /// </summary>
         [JsonProperty("result", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
         string? Result { get; set; } 

Src/ChatApi.Core/Models/Interfaces/IOperationSuccess.cs

@@ -2,12 +2,11 @@
 
 namespace ChatApi.Core.Models.Interfaces
 {
-    //Need description:chatApi
-    /// <summary/>
+    /// <inheritdoc cref="Success"/>
     public interface IOperationSuccess
     {
         /// <summary>
-        /// 
+        ///     Flag of the success of the request
         /// </summary>
         [JsonProperty("success", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
         bool? Success { get; set; }

Src/ChatApi.Core/Models/MessageType.cs

@@ -2,8 +2,9 @@
 
 namespace ChatApi.Core.Models
 {
-    //Need description:chatApi
-    /// <summary/>
+    /// <summary>
+    ///     Type of the message
+    /// </summary>
     public enum MessageType : byte
     {
         /// <summary/>

Src/ChatApi.WA.Account/Models/InstanceStatus.cs

@@ -15,7 +15,7 @@ public class InstanceStatus : Printable, IExpiry, ILogout, IRetry, ITakeover, IL
         /// <inheritdoc />
         public string? Label { get; set; }
         /// <inheritdoc />
-        public InstanceStatusActionType? Action { get; set; }
+        public InstanceStatusActionType? ActionType { get; set; }
 
         #endregion
 
@@ -24,7 +24,7 @@ public class InstanceStatus : Printable, IExpiry, ILogout, IRetry, ITakeover, IL
         /// <inheritdoc />
         public bool Equals(IInstanceStatus? other)
         {
-            return other is not null && Action == other.Action &&
+            return other is not null && ActionType == other.ActionType &&
                    string.Equals(Link, other.Link, StringComparison.Ordinal) &&
                    string.Equals(Label, other.Label, StringComparison.Ordinal);
         }
@@ -38,7 +38,7 @@ public override int GetHashCode()
         {
             unchecked
             {
-                int hashCode = Action is not null ? Action.GetHashCode() : 0;
+                int hashCode = ActionType is not null ? ActionType.GetHashCode() : 0;
                 hashCode = (hashCode * 397) ^ (Label is not null ? Label.GetHashCode() : 0);
                 hashCode = (hashCode * 397) ^ (Link is not null ? Link.GetHashCode() : 0);
                 return hashCode;
@@ -57,7 +57,7 @@ public override int GetHashCode()
         /// <inheritdoc />
         protected override void PrintContent(int shift)
         {
-            AddMember(nameof(Action), Action, shift);
+            AddMember(nameof(ActionType), ActionType, shift);
             AddMember(nameof(Label), Label, shift);
             AddMember(nameof(Link), Link, shift);
         }

Src/ChatApi.WA.Account/Models/Interfaces/IInstanceStatus.cs

@@ -11,7 +11,7 @@ public interface IInstanceStatus : IEquatable<IInstanceStatus?>, IPrintable
         ///     Method name
         /// </summary>
         [JsonProperty("act", NullValueHandling = NullValueHandling.Ignore)]
-        InstanceStatusActionType? Action { get; set; } 
+        InstanceStatusActionType? ActionType { get; set; } 
 
         /// <summary>
         ///     Action caption for the button