From 3b9ac0238d81ad89d2ebc8f6fbb5a3c0fb01781a Mon Sep 17 00:00:00 2001
From: FH <fh@uex.dk>
Date: Wed, 16 Nov 2022 11:33:41 +0100
Subject: [PATCH] documentation

---
 BrAddressModel.cs     | 24 ++++++++++++++++++++++++
 BrCompanyModel.cs     | 30 ++++++++++++++++++++++++++++++
 BrCompanyTypeModel.cs | 12 ++++++++++++
 BrHttpRequest.cs      |  9 +++++++++
 BrRegQuery.cs         |  6 ++++++
 BrResponseParser.cs   |  8 ++++++++
 BrResponseView.cs     | 12 ++++++++++++
 BrVatInfoMapper.cs    | 18 ++++++++++++++++++
 FCS.Lib.BrReg.csproj  |  1 +
 9 files changed, 120 insertions(+)

diff --git a/BrAddressModel.cs b/BrAddressModel.cs
index f1d591d..ecd8d31 100644
--- a/BrAddressModel.cs
+++ b/BrAddressModel.cs
@@ -28,13 +28,37 @@ using System.Collections.Generic;
 
 namespace FCS.Lib.BrReg;
 
+/// <summary>
+/// 
+/// </summary>
 public class BrAddressModel
 {
+    /// <summary>
+    /// entity country
+    /// </summary>
     public string Land { get; set; } = "";
+    /// <summary>
+    /// entity country code
+    /// </summary>
     public string Landkode { get; set; } = "";
+    /// <summary>
+    /// entity zip code
+    /// </summary>
     public string Postnummer { get; set; } = "";
+    /// <summary>
+    /// entity postal name
+    /// </summary>
     public string Poststed { get; set; } = "";
+    /// <summary>
+    /// entity address
+    /// </summary>
     public List<string> Adresse { get; set; } = new();
+    /// <summary>
+    /// entity municipal
+    /// </summary>
     public string Kommune { get; set; } = "";
+    /// <summary>
+    /// entity municipal identification
+    /// </summary>
     public string Kommunenummer { get; set; } = "";
 }
\ No newline at end of file
diff --git a/BrCompanyModel.cs b/BrCompanyModel.cs
index f64d730..4a0b8f4 100644
--- a/BrCompanyModel.cs
+++ b/BrCompanyModel.cs
@@ -26,16 +26,46 @@
 
 namespace FCS.Lib.BrReg
 {
+    /// <summary>
+    /// 
+    /// </summary>
     public class BrCompanyModel
     {
+        /// <summary>
+        /// Entity vat number
+        /// </summary>
         public string Organisasjonsnummer { get; set; } = "";
+        /// <summary>
+        /// Entity name
+        /// </summary>
         public string Navn { get; set; } = "";
+        /// <summary>
+        /// Entity deletion date
+        /// </summary>
         public string Slettedato { get; set; } = "";
+        /// <summary>
+        /// Entity business type
+        /// </summary>
         public BrCompanyTypeModel Organisasjonsform { get; set; } = new();
+        /// <summary>
+        /// entity postal address
+        /// </summary>
         public BrAddressModel Postadresse { get; set; } = new();
+        /// <summary>
+        /// entity business address
+        /// </summary>
         public BrAddressModel Forretningsadresse { get; set; } = new();
+        /// <summary>
+        /// entity out-of-business flag
+        /// </summary>
         public bool Konkurs { get; set; }
+        /// <summary>
+        /// entity to be closed flag
+        /// </summary>
         public bool UnderAvvikling { get; set; }
+        /// <summary>
+        /// entity to be force closed
+        /// </summary>
         public bool UnderTvangsavviklingEllerTvangsopplosning { get; set; }
 
     }
diff --git a/BrCompanyTypeModel.cs b/BrCompanyTypeModel.cs
index 81dcb6f..ecd4785 100644
--- a/BrCompanyTypeModel.cs
+++ b/BrCompanyTypeModel.cs
@@ -25,9 +25,21 @@
 // ***********************************************************************
 namespace FCS.Lib.BrReg;
 
+/// <summary>
+/// Class BrCompanyTypeModel
+/// </summary>
 public class BrCompanyTypeModel
 {
+    /// <summary>
+    /// BrReg business code
+    /// </summary>
     public string Kode { get; set; } = "";
+    /// <summary>
+    /// BrReg description
+    /// </summary>
     public string Beskrivelse { get; set; } = "";
+    /// <summary>
+    /// BrReg discontinued
+    /// </summary>
     public string Utgaatt { get; set; } = "";
 }
\ No newline at end of file
diff --git a/BrHttpRequest.cs b/BrHttpRequest.cs
index 00b6761..da38e79 100644
--- a/BrHttpRequest.cs
+++ b/BrHttpRequest.cs
@@ -29,8 +29,17 @@ using System.Threading.Tasks;
 
 namespace FCS.Lib.BrReg
 {
+    /// <summary>
+    /// Class BrHttpRequest
+    /// </summary>
     public class BrHttpRequest
     {
+        /// <summary>
+        /// Async http request
+        /// </summary>
+        /// <param name="endpoint"></param>
+        /// <param name="userAgent"></param>
+        /// <returns><see cref="BrResponseView"/></returns>
         public async Task<BrResponseView> GetResponseAsync(string endpoint, string userAgent)
         {
             using var client = new HttpClient();
diff --git a/BrRegQuery.cs b/BrRegQuery.cs
index 6cd96ab..e1233f9 100644
--- a/BrRegQuery.cs
+++ b/BrRegQuery.cs
@@ -1,7 +1,13 @@
 namespace FCS.Lib.BrReg;
 
+/// <summary>
+/// BrRegQuery
+/// </summary>
 public class BrRegQuery
 {
+    /// <summary>
+    /// Vat number
+    /// </summary>
     public string VatNumber { get; set; }
 
 }
\ No newline at end of file
diff --git a/BrResponseParser.cs b/BrResponseParser.cs
index 27fd89b..7b16526 100644
--- a/BrResponseParser.cs
+++ b/BrResponseParser.cs
@@ -28,8 +28,16 @@ using Newtonsoft.Json;
 
 namespace FCS.Lib.BrReg
 {
+    /// <summary>
+    /// Class BrResponseParser
+    /// </summary>
     public class BrResponseParser
     {
+        /// <summary>
+        /// Parse response to BrCompanyModel
+        /// </summary>
+        /// <param name="responseData"></param>
+        /// <returns><see cref="BrCompanyModel"/></returns>
         public BrCompanyModel ParseBrResponse(string responseData)
         {
             return JsonConvert.DeserializeObject<BrCompanyModel>(responseData);
diff --git a/BrResponseView.cs b/BrResponseView.cs
index b8575a0..6b5b7c2 100644
--- a/BrResponseView.cs
+++ b/BrResponseView.cs
@@ -28,10 +28,22 @@ using System.Net;
 
 namespace FCS.Lib.BrReg
 {
+    /// <summary>
+    /// Class BrResponseView
+    /// </summary>
     public class BrResponseView
     {
+        /// <summary>
+        /// http response status code
+        /// </summary>
         public HttpStatusCode Code { get; set; }
+        /// <summary>
+        /// Flag indicating success
+        /// </summary>
         public bool IsSuccessStatusCode { get; set; }
+        /// <summary>
+        /// Response message
+        /// </summary>
         public string Message { get; set; } = "";
     }
 }
\ No newline at end of file
diff --git a/BrVatInfoMapper.cs b/BrVatInfoMapper.cs
index 51bb9d7..ea86307 100644
--- a/BrVatInfoMapper.cs
+++ b/BrVatInfoMapper.cs
@@ -30,9 +30,21 @@ using FCS.Lib.Common;
 
 namespace FCS.Lib.BrReg
 {
+    /// <summary>
+    /// Class BrVatInfoMapper
+    /// </summary>
     public class BrVatInfoMapper
     {
 
+        /// <summary>
+        /// Map BrCompanyModel to CRM
+        /// </summary>
+        /// <param name="brCompany"></param>
+        /// <returns><see cref="VatInfoDto"/></returns>
+        /// <see cref="BrCompanyModel"/>
+        /// <see cref="VatState"/>
+        /// <see cref="LifeCycle"/>
+        /// <see cref="TimeFrame"/>
         public VatInfoDto MapBrToCrm(BrCompanyModel brCompany)
         {
             return new VatInfoDto
@@ -69,6 +81,12 @@ namespace FCS.Lib.BrReg
                 }
             };
         }
+
+        /// <summary>
+        /// Map BrCompanyModel to VatStateInfo
+        /// </summary>
+        /// <param name="brCompany"></param>
+        /// <returns><see cref="VatStateInfo"/></returns>
         public VatStateInfo MapBrVatState(BrCompanyModel brCompany)
         {
             if (brCompany == null)
diff --git a/FCS.Lib.BrReg.csproj b/FCS.Lib.BrReg.csproj
index c9658d3..b4a84e5 100644
--- a/FCS.Lib.BrReg.csproj
+++ b/FCS.Lib.BrReg.csproj
@@ -24,6 +24,7 @@
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Debug\FCS.Lib.BrReg.xml</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>