documentation

FCS.Lib.Common.csproj

@@ -24,6 +24,7 @@
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Debug\FCS.Lib.Common.xml</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>

LifeCycle.cs

@@ -25,9 +25,19 @@
 // ***********************************************************************
 namespace FCS.Lib.Common
 {
+    /// <summary>
+    /// Class LifeCycle
+    /// </summary>
     public class LifeCycle
     {
+        /// <summary>
+        /// Cycle last updated
+        /// </summary>
         public string LastUpdate { get; set; } = "";
+        /// <summary>
+        /// Time Frame for life cycle
+        /// </summary>
+        /// <see cref="TimeFrame"/>
         public TimeFrame TimeFrame { get; set; } = new ();
 
     }

TimeFrame.cs

@@ -25,9 +25,18 @@
 // ***********************************************************************
 namespace FCS.Lib.Common
 {
+    /// <summary>
+    /// Class TimeFrame
+    /// </summary>
     public class TimeFrame
     {
+        /// <summary>
+        /// From date
+        /// </summary>
         public string StartDate { get; set; } = "";
+        /// <summary>
+        /// To date
+        /// </summary>
         public string EndDate { get; set; } = "";
     }
 }

VatInfoDto.cs

@@ -28,16 +28,46 @@ using System.Collections.Generic;
 
 namespace FCS.Lib.Common
 {
+    /// <summary>
+    /// Class VatInfoDto
+    /// </summary>
     public class VatInfoDto
     {
+        /// <summary>
+        /// Entity vat number
+        /// </summary>
         public string VatNumber { get; set; } = "";
+        /// <summary>
+        /// Entity name
+        /// </summary>
         public string Name { get; set; } = "";
+        /// <summary>
+        /// Entity co-location name
+        /// </summary>
         public string CoName { get; set; } = "";
+        /// <summary>
+        /// Entity address
+        /// </summary>
         public string Address { get; set; } = "";
+        /// <summary>
+        /// Entity City
+        /// </summary>
         public string City { get; set; } = "";
+        /// <summary>
+        /// Entity postal code
+        /// </summary>
         public string ZipCode { get; set; } = "";
+        /// <summary>
+        /// List of entity states
+        /// </summary>
         public List<VatState> States { get; set; } = new();
+        /// <summary>
+        /// List of entity life cycles
+        /// </summary>
         public List<LifeCycle> LifeCycles { get; set; } = new();
+        /// <summary>
+        /// Registrar request date
+        /// </summary>
         public string RequestDate { get; set; }
     }
 }

VatState.cs

@@ -25,10 +25,23 @@
 // ***********************************************************************
 namespace FCS.Lib.Common
 {
+    /// <summary>
+    /// Class VatState
+    /// </summary>
     public class VatState
     {
+        /// <summary>
+        /// Last update of vatState
+        /// </summary>
         public string LastUpdate { get; set; } = "";
+        /// <summary>
+        /// The state
+        /// </summary>
         public string State { get; set; } = "";
+        /// <summary>
+        /// Time frame
+        /// </summary>
+        /// <see cref="TimeFrame"/>
         public TimeFrame TimeFrame { get; set; } = new();
     }
 }

VatStateInfo.cs

@@ -2,12 +2,30 @@
 
 namespace FCS.Lib.Common
 {
+    /// <summary>
+    /// Class VatStateInfo
+    /// </summary>
     public class VatStateInfo
     {
+        /// <summary>
+        /// Business entity name
+        /// </summary>
         public string Name { get; set; } = "";
+        /// <summary>
+        /// Business entity vat number
+        /// </summary>
         public string VatNumber { get; set; } = "";
+        /// <summary>
+        /// Flag indicating valid format
+        /// </summary>
         public bool VatNumberValid { get; set; }
+        /// <summary>
+        /// Flag indicating if entity is out of business
+        /// </summary>
         public bool HasFolded  { get; set; }
+        /// <summary>
+        /// Request date
+        /// </summary>
         public DateTime RequestDate { get; set; }
     }
 }