documentation added, version tagging

OpenTrans.net/Contact.cs

@@ -23,22 +23,70 @@ namespace OpenTrans.net
     /**
      * @todo add missing attribute: Phone, Fax (typed), page 62 of spec
      */
+
+    /// <summary>
+    /// This element contains informations about a contact person.
+    /// </summary>
     public class Contact
     {
+        /// <summary>
+        /// Unique ID of the contact person
+        /// </summary>
         public string Id { get; set; }
+
         /// <summary>
-        /// Nachname des Ansprechpartners
+        /// Last name of the contact
         /// </summary>
         public string Name { get; set; }
+
+        /// <summary>
+        /// First name of the contact person
+        /// </summary>
         public string FirstName { get; set; }
+
+        /// <summary>
+        /// Form of address, e.g., Mr., Ms.
+        /// </summary>
         public string Title { get; set; }
+
+        /// <summary>
+        /// Academic title of the contact person, e.g., Dr
+        /// </summary>
         public string AcademicTitle { get; set; }
+
+        /// <summary>
+        /// Roles or positions of a contact
+        /// </summary>
         public List<string> Roles { get; set; } = new List<string>();
+
+        /// <summary>
+        /// Additional information on the contact person
+        /// </summary>
         public string Description { get; set; }
+
+        /// <summary>
+        /// URL of the web site
+        /// </summary>
         public string Url { get; set; }
+
+        /// <summary>
+        /// Phone number
+        /// </summary>
         public string PhoneNo { get; set; }
+
+        /// <summary>
+        /// Fax number
+        /// </summary>
         public string FaxNo { get; set; }
+
+        /// <summary>
+        /// List of e-mail addresses
+        /// </summary>
         public List<string> EmailAddresses { get; set; } = new List<string>();
+
+        /// <summary>
+        /// Authentification information
+        /// </summary>
         public string Authentification { get; set; }
     }
 }

OpenTrans.net/OpenTrans.net.csproj

@@ -4,9 +4,9 @@
     <TargetFramework>netstandard2.0</TargetFramework>
     <PackageLicenseExpression>http://www.apache.org/licenses/LICENSE-2.0</PackageLicenseExpression>
     <Authors>Stephan Stapel, [email protected]</Authors>
-    <Version>3.0.0</Version>
-    <AssemblyVersion>3.0.0.0</AssemblyVersion>
-    <FileVersion>2.0.0.0</FileVersion>
+    <Version>4.0.0</Version>
+    <AssemblyVersion>4.0.0.0</AssemblyVersion>
+    <FileVersion>4.0.0.0</FileVersion>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">

OpenTrans.net/Order.cs

@@ -54,7 +54,7 @@ public static Order Load(string filename)
 
 
         /// <summary>
-        /// Saves the descriptor object into a stream.
+        /// Saves the order object into a stream.
         /// 
         /// The stream position will be reset to the original position after writing is finished.
         /// This allows easy further processing of the stream.

OpenTrans.net/OrderResponse.cs

@@ -51,7 +51,7 @@ public static OrderResponse Load(string filename)
 
 
         /// <summary>
-        /// Saves the descriptor object into a stream.
+        /// Saves the order response object into a stream.
         /// 
         /// The stream position will be reset to the original position after writing is finished.
         /// This allows easy further processing of the stream.

OpenTrans.net/OrderSummary.cs

@@ -18,8 +18,14 @@
  */
 namespace OpenTrans.net
 {
+    /// <summary>
+    /// The summary contains information on the number of item lines in the order. This figure is used for control purposes to make sure that all items have been transferred
+    /// </summary>
     public class OrderSummary
     {
+        /// <summary>
+        /// Total amount covering all items in this business document
+        /// </summary>
         public decimal? TotalAmount { get; set; }
     }
 }

OpenTrans.net/Party.cs

@@ -20,27 +20,109 @@
 
 namespace OpenTrans.net
 {
+    /// <summary>
+    /// This element contains information about a business partner.
+    /// </summary>
     public class Party
     {
+        /// <summary>
+        /// Unique identifier of the business partner
+        /// </summary>
         public List<PartyId> Ids { get; set; } = new List<PartyId>();
+
+        /// <summary>
+        /// Role of the business partner in the context of this document
+        /// </summary>
         public List<PartyRoles> Roles { get; set; } = new List<PartyRoles>();
+
+        /// <summary>
+        /// First address line, in most cases the name of the organisation
+        /// </summary>
         public string Name { get; set; }
+
+        /// <summary>
+        /// additional space for address information
+        /// </summary>
         public string Name2 { get; set; }
+
+        /// <summary>
+        /// additional space for address information
+        /// </summary>
         public string Name3 { get; set; }
+
+        /// <summary>
+        /// Department of the organisation
+        /// </summary>
         public string Department { get; set; }
+
+        /// <summary>
+        /// Street name and house number
+        /// </summary>
         public string Street { get; set; }
+
+        /// <summary>
+        /// ZIP code of address
+        /// </summary>
         public string Zip { get; set; }
+
+        /// <summary>
+        /// P.O. box number
+        /// </summary>
         public string BoxNo { get; set; }
+
+        /// <summary>
+        /// ZIP code of P.O. box
+        /// </summary>
         public string ZipBox { get; set; }
+
+        /// <summary>
+        /// Town or city of the company
+        /// </summary>
         public string City { get; set; }
+
+        /// <summary>
+        /// Federal state
+        /// </summary>
         public string State { get; set; }
+
+        /// <summary>
+        /// VAT identification number of the business partner
+        /// </summary>
         public string VATId { get; set; }
+
+        /// <summary>
+        /// Tax number of a business partner
+        /// </summary>
         public string TaxNumber { get; set; }
+
+        /// <summary>
+        /// Country code
+        /// </summary>
         public CountryCodes CountryCode { get; set; }
+
+        /// <summary>
+        /// Information on a contact person
+        /// </summary>
         public Contact ContactDetails { get; set; }
+
+        /// <summary>
+        /// Fax number
+        /// </summary>
         public string FaxNo { get; set; }
+
+        /// <summary>
+        /// Phone number
+        /// </summary>
         public string PhoneNo { get; set; }
+
+        /// <summary>
+        /// e-mail address
+        /// </summary>
         public string EmailAddress { get; set; }
+
+        /// <summary>
+        /// URL of the company's web site
+        /// </summary>
         public string Url { get; set; }
     }
 }