[Add] generation of SBOM; fixes #56

samatstariongroup · samatstariongroup · commit 7c96490ca887 · 2025-08-08T11:13:47.000+02:00
[Add] generation of documentation and improve XML docs

[Add] GenerateDocumentationFile and improve XML docs
diff --git a/ReqIFSharp.Extensions/ReqIFExtensions/AttributeValueExtensions.cs b/ReqIFSharp.Extensions/ReqIFExtensions/AttributeValueExtensions.cs
@@ -35,7 +35,7 @@ public static class AttributeValueExtensions
         /// Queries the value of the <see cref="AttributeValue"/> as a formatted string
         /// </summary>
         /// <param name="attributeValue">
-        /// the subjectr <see cref="attributeValue"/>
+        /// the subject <see cref="AttributeValue"/>
         /// </param>
         /// <returns>
         /// a formatted string
diff --git a/ReqIFSharp.Extensions/ReqIFSharp.Extensions.csproj b/ReqIFSharp.Extensions/ReqIFSharp.Extensions.csproj
@@ -3,6 +3,8 @@
   <PropertyGroup>
       <TargetFramework>netstandard2.0</TargetFramework>
       <Version>4.2.0</Version>
+      <LangVersion>12.0</LangVersion>
+      <Title>ReqIFSharp.Extensions</Title>
       <Description>A .NET library that provides extenions and services to operate on ReqIF documents.</Description>
       <PackageId>ReqIFSharp.Extensions</PackageId>
       <Company>Starion Group S.A.</Company>
@@ -11,17 +13,20 @@
       <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
       <RepositoryUrl>https://github.com/STARIONGROUP/reqifsharp.git</RepositoryUrl>
       <RepositoryType>Git</RepositoryType>
+      <NeutralLanguage>en-US</NeutralLanguage>
+      <SatelliteResourceLanguages>en-US</SatelliteResourceLanguages>
       <PackageIcon>reqifsharp-extensions-logo-small.png</PackageIcon>
       <PackageTags>ReqIF mbse modeltopia</PackageTags>
       <GeneratePackageOnBuild>False</GeneratePackageOnBuild>
       <Authors>Sam Gerené</Authors>
       <RequireLicenseAcceptance>false</RequireLicenseAcceptance>
       <IncludeSource>true</IncludeSource>
       <IncludeSymbols>true</IncludeSymbols>
+      <GenerateDocumentationFile>true</GenerateDocumentationFile>
+      <GenerateSBOM>true</GenerateSBOM>
       <PackageReleaseNotes>
           - [Update] to reqifsharp version 9.2.0
       </PackageReleaseNotes>
-      <LangVersion>latest</LangVersion>
       <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
@@ -38,4 +43,8 @@
     <None Include="..\README.md" Pack="true" PackagePath="\" />
   </ItemGroup>
 
+    <ItemGroup>
+        <PackageReference Include="Microsoft.Sbom.Targets" Version="4.1.0" PrivateAssets="all" />
+    </ItemGroup>
+
 </Project>
diff --git a/ReqIFSharp/AlternativeID.cs b/ReqIFSharp/AlternativeID.cs
@@ -127,6 +127,9 @@ internal void ReadXml(XmlReader reader)
         /// <param name="reader">
         /// an instance of <see cref="XmlReader"/>
         /// </param>
+        /// <param name="token">
+        /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
+        /// </param>
         internal async Task ReadXmlAsync(XmlReader reader, CancellationToken token)
         {
             while (await reader.ReadAsync())
diff --git a/ReqIFSharp/AttributeDefinition/AttributeDefinitionEnumeration.cs b/ReqIFSharp/AttributeDefinition/AttributeDefinitionEnumeration.cs
@@ -193,6 +193,9 @@ internal override void ReadXml(XmlReader reader)
         /// <param name="reader">
         /// an instance of <see cref="XmlReader"/>
         /// </param>
+        /// <param name="token">
+        /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
+        /// </param>
         internal override async Task ReadXmlAsync(XmlReader reader, CancellationToken token)
         {
             base.ReadXml(reader);
diff --git a/ReqIFSharp/Datatype/DatatypeDefinition.cs b/ReqIFSharp/Datatype/DatatypeDefinition.cs
@@ -53,7 +53,7 @@ protected DatatypeDefinition(ILoggerFactory loggerFactory) : base(loggerFactory)
         /// Initializes a new instance of the <see cref="DatatypeDefinition"/> class.
         /// </summary>
         /// <param name="reqIfContent">
-        /// The owning <see cref="reqIfContent"/>
+        /// The owning <see cref="ReqIFContent"/>
         /// </param>
         /// <param name="loggerFactory">
         /// The (injected) <see cref="ILoggerFactory"/> used to set up logging
diff --git a/ReqIFSharp/Datatype/DatatypeDefinitionBoolean.cs b/ReqIFSharp/Datatype/DatatypeDefinitionBoolean.cs
@@ -56,7 +56,7 @@ public DatatypeDefinitionBoolean(ILoggerFactory loggerFactory)
         /// Initializes a new instance of the <see cref="DatatypeDefinitionBoolean"/> class.
         /// </summary>
         /// <param name="reqIfContent">
-        /// The owning <see cref="reqIfContent"/>
+        /// The owning <see cref="ReqIFContent"/>
         /// </param>
         /// <param name="loggerFactory">
         /// The (injected) <see cref="ILoggerFactory"/> used to set up logging
diff --git a/ReqIFSharp/Datatype/DatatypeDefinitionDate.cs b/ReqIFSharp/Datatype/DatatypeDefinitionDate.cs
@@ -57,7 +57,7 @@ public DatatypeDefinitionDate(ILoggerFactory loggerFactory)
         /// Initializes a new instance of the <see cref="DatatypeDefinitionDate"/> class.
         /// </summary>
         /// <param name="reqIfContent">
-        /// The owning <see cref="reqIfContent"/>
+        /// The owning <see cref="ReqIFContent"/>
         /// </param>
         /// <param name="loggerFactory">
         /// The (injected) <see cref="ILoggerFactory"/> used to set up logging
diff --git a/ReqIFSharp/Datatype/DatatypeDefinitionEnumeration.cs b/ReqIFSharp/Datatype/DatatypeDefinitionEnumeration.cs
@@ -73,7 +73,7 @@ public DatatypeDefinitionEnumeration(ILoggerFactory loggerFactory)
         /// Initializes a new instance of the <see cref="DatatypeDefinitionEnumeration"/> class.
         /// </summary>
         /// <param name="reqIfContent">
-        /// The owning <see cref="reqIfContent"/>
+        /// The owning <see cref="ReqIFContent"/>
         /// </param>
         /// <param name="loggerFactory">
         /// The (injected) <see cref="ILoggerFactory"/> used to set up logging
diff --git a/ReqIFSharp/Datatype/DatatypeDefinitionInteger.cs b/ReqIFSharp/Datatype/DatatypeDefinitionInteger.cs
@@ -58,7 +58,7 @@ public DatatypeDefinitionInteger(ILoggerFactory loggerFactory)
         /// Initializes a new instance of the <see cref="DatatypeDefinitionInteger"/> class.
         /// </summary>
         /// <param name="reqIfContent">
-        /// The owning <see cref="reqIfContent"/>
+        /// The owning <see cref="ReqIFContent"/>
         /// </param>
         /// <param name="loggerFactory">
         /// The (injected) <see cref="ILoggerFactory"/> used to set up logging
diff --git a/ReqIFSharp/Datatype/DatatypeDefinitionReal.cs b/ReqIFSharp/Datatype/DatatypeDefinitionReal.cs
@@ -53,7 +53,7 @@ public DatatypeDefinitionReal(ILoggerFactory loggerFactory)
         /// Initializes a new instance of the <see cref="DatatypeDefinitionReal"/> class.
         /// </summary>
         /// <param name="reqIfContent">
-        /// The owning <see cref="reqIfContent"/>
+        /// The owning <see cref="ReqIFContent"/>
         /// </param>
         /// <param name="loggerFactory">
         /// The (injected) <see cref="ILoggerFactory"/> used to set up logging
diff --git a/ReqIFSharp/Datatype/DatatypeDefinitionSimple.cs b/ReqIFSharp/Datatype/DatatypeDefinitionSimple.cs
@@ -49,7 +49,7 @@ protected DatatypeDefinitionSimple(ILoggerFactory loggerFactory)
         /// Initializes a new instance of the <see cref="DatatypeDefinitionSimple"/> class.
         /// </summary>
         /// <param name="reqIfContent">
-        /// The owning <see cref="reqIfContent"/>
+        /// The owning <see cref="ReqIFContent"/>
         /// </param>
         /// <param name="loggerFactory">
         /// The (injected) <see cref="ILoggerFactory"/> used to set up logging
diff --git a/ReqIFSharp/Datatype/DatatypeDefinitionString.cs b/ReqIFSharp/Datatype/DatatypeDefinitionString.cs
@@ -56,7 +56,7 @@ public DatatypeDefinitionString(ILoggerFactory loggerFactory)
         /// Initializes a new instance of the <see cref="DatatypeDefinitionString"/> class.
         /// </summary>
         /// <param name="reqIfContent">
-        /// The owning <see cref="reqIfContent"/>
+        /// The owning <see cref="ReqIFContent"/>
         /// </param>
         /// <param name="loggerFactory">
         /// The (injected) <see cref="ILoggerFactory"/> used to set up logging
diff --git a/ReqIFSharp/Datatype/DatatypeDefinitionXHTML.cs b/ReqIFSharp/Datatype/DatatypeDefinitionXHTML.cs
@@ -53,7 +53,7 @@ public DatatypeDefinitionXHTML(ILoggerFactory loggerFactory)
         /// Initializes a new instance of the <see cref="DatatypeDefinitionXHTML"/> class.
         /// </summary>
         /// <param name="reqIfContent">
-        /// The owning <see cref="reqIfContent"/>
+        /// The owning <see cref="ReqIFContent"/>
         /// </param>
         /// <param name="loggerFactory">
         /// The (injected) <see cref="ILoggerFactory"/> used to set up logging
@@ -82,6 +82,9 @@ internal override void ReadXml(XmlReader reader)
         /// <param name="reader">
         /// an instance of <see cref="XmlReader"/>
         /// </param>
+        /// <param name="token">
+        /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
+        /// </param>
         internal override async Task ReadXmlAsync(XmlReader reader, CancellationToken token)
         {
             base.ReadXml(reader);
diff --git a/ReqIFSharp/IReqIFSerializer.cs b/ReqIFSharp/IReqIFSerializer.cs
@@ -40,12 +40,16 @@ public interface IReqIFSerializer
         /// <summary>
         /// Serialize a <see cref="IEnumerable{ReqIF}"/> object and write its content to the provided <see cref="Stream"/>
         /// </summary>
-        /// <param name="reqIfs">
+        /// <param name="reqifs">
         /// The <see cref="ReqIF"/> object to serialize
         /// </param>
         /// <param name="stream">
         /// The <see cref="Stream"/> to serialize to
         /// </param>
+        /// <param name="fileExtensionKind">
+        /// The <see cref="SupportedFileExtensionKind"/> that specifies whether the resulting <see cref="Stream"/>
+        /// contains the reqif file or a zip-archive of reqif files
+        /// </param>
         void Serialize(IEnumerable<ReqIF> reqifs, Stream stream, SupportedFileExtensionKind fileExtensionKind);
 
         /// <summary>
@@ -67,6 +71,10 @@ public interface IReqIFSerializer
         /// <param name="stream">
         /// The <see cref="Stream"/> to serialize to
         /// </param>
+        /// <param name="fileExtensionKind">
+        /// The <see cref="SupportedFileExtensionKind"/> that specifies whether the resulting <see cref="Stream"/>
+        /// contains the reqif file or a zip-archive of reqif files
+        /// </param>
         /// <param name="token">
         /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
         /// </param>
diff --git a/ReqIFSharp/ReqIF.cs b/ReqIFSharp/ReqIF.cs
@@ -21,7 +21,6 @@
 namespace ReqIFSharp
 {
     using System.Collections.Generic;
-    using System.Linq;
     using System.Threading;
     using System.Threading.Tasks;
     using System.Xml;
@@ -90,7 +89,7 @@ internal ReqIF(ILoggerFactory loggerFactory)
         /// Gets or sets the default language encoding of the Exchange XML Document content
         /// </summary>
         /// <remarks>
-        /// The format is defined by the standard for specifying languages in XML documents proposed by the W3C <see cref="http://www.w3.org/TR/xml11/#sec-lang-tag"/>
+        /// The format is defined by the standard for specifying languages in XML documents proposed by the <a href="http://www.w3.org/TR/xml11/#sec-lang-tag"> W3C </a>
         /// </remarks>
         public string Lang { get; set; }
 
diff --git a/ReqIFSharp/ReqIFSharp.csproj b/ReqIFSharp/ReqIFSharp.csproj
@@ -5,6 +5,8 @@
     <PropertyGroup>
         <TargetFramework>netstandard2.0</TargetFramework>
         <Version>9.2.0</Version>
+        <LangVersion>12.0</LangVersion>
+        <Title>ReqIFSharp</Title>
         <Description>A .NET library to deserialize (read) and serialize (write) OMG ReqIF documents.</Description>
         <PackageId>ReqIFSharp</PackageId>
         <Company>Starion Group S.A.</Company>
@@ -13,28 +15,23 @@
         <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
         <RepositoryUrl>https://github.com/STARIONGROUP/reqifsharp.git</RepositoryUrl>
         <RepositoryType>Git</RepositoryType>
+        <NeutralLanguage>en-US</NeutralLanguage>
+        <SatelliteResourceLanguages>en-US</SatelliteResourceLanguages>
         <PackageIcon>reqifsharp-logo-small.png</PackageIcon>
         <PackageTags>ReqIF mbse modeltopia</PackageTags>
         <GeneratePackageOnBuild>False</GeneratePackageOnBuild>
         <Authors>Sam Gerené, Naron Phou, Alexander van Delft</Authors>
         <RequireLicenseAcceptance>false</RequireLicenseAcceptance>
         <IncludeSource>true</IncludeSource>
         <IncludeSymbols>true</IncludeSymbols>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
+        <GenerateSBOM>true</GenerateSBOM>
         <PackageReleaseNotes>
             - [Update] Microsoft.Extensions.Logging.Abstractions to version 9.0.7
         </PackageReleaseNotes>
         <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
-    <PropertyGroup Condition="'$(Configuration)'=='Debug'">
-        <DefineConstants>TRACE;DEBUG;</DefineConstants>
-    </PropertyGroup>
-
-    <PropertyGroup Condition="'$(Configuration)'=='Release'">
-        <IncludeSymbols>true</IncludeSymbols>
-        <DefineConstants>RELEASE</DefineConstants>
-    </PropertyGroup>
-
     <ItemGroup>
         <None Remove="Resources\driver.xsd" />
         <None Remove="Resources\reqif.xsd" />
@@ -90,6 +87,7 @@
 
     <ItemGroup>
         <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="9.0.8" />
+        <PackageReference Include="Microsoft.Sbom.Targets" Version="4.1.0" PrivateAssets="all" />
     </ItemGroup>
 
 </Project>
diff --git a/ReqIFSharp/SpecElementWithAttributes/RelationGroup.cs b/ReqIFSharp/SpecElementWithAttributes/RelationGroup.cs
@@ -76,7 +76,7 @@ public RelationGroup(ILoggerFactory loggerFactory)
         /// Initializes a new instance of the <see cref="RelationGroup"/> class.
         /// </summary>
         /// <param name="reqIfContent">
-        /// The container <see cref="reqIfContent"/>
+        /// The container <see cref="ReqIFContent"/>
         /// </param>
         /// <param name="loggerFactory">
         /// The (injected) <see cref="ILoggerFactory"/> used to set up logging
diff --git a/ReqIFSharp/SpecElementWithAttributes/SpecElementWithAttributes.cs b/ReqIFSharp/SpecElementWithAttributes/SpecElementWithAttributes.cs
@@ -73,7 +73,7 @@ protected SpecElementWithAttributes(ILoggerFactory loggerFactory)
         /// Initializes a new instance of the <see cref="SpecElementWithAttributes"/> class.
         /// </summary>
         /// <param name="reqIfContent">
-        /// The container <see cref="reqIfContent"/>
+        /// The container <see cref="ReqIFContent"/>
         /// </param>
         /// <param name="loggerFactory">
         /// The (injected) <see cref="ILoggerFactory"/> used to set up logging
diff --git a/ReqIFSharp/SpecElementWithAttributes/SpecHierarchy.cs b/ReqIFSharp/SpecElementWithAttributes/SpecHierarchy.cs
@@ -291,6 +291,9 @@ internal override void WriteXml(XmlWriter writer)
         /// <param name="writer">
         /// an instance of <see cref="XmlWriter"/>
         /// </param>
+        /// <param name="token">
+        /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
+        /// </param>
         /// <exception cref="SerializationException">
         /// The Object property may not be null.
         /// </exception>
diff --git a/ReqIFSharp/SpecElementWithAttributes/SpecObject.cs b/ReqIFSharp/SpecElementWithAttributes/SpecObject.cs
@@ -69,7 +69,7 @@ public SpecObject(ILoggerFactory loggerFactory)
         /// Initializes a new instance of the <see cref="SpecObject"/> class.
         /// </summary>
         /// <param name="reqIfContent">
-        /// The container <see cref="reqIfContent"/>
+        /// The container <see cref="ReqIFContent"/>
         /// </param>
         /// <param name="loggerFactory">
         /// The (injected) <see cref="ILoggerFactory"/> used to set up logging
diff --git a/ReqIFSharp/SpecElementWithAttributes/SpecRelation.cs b/ReqIFSharp/SpecElementWithAttributes/SpecRelation.cs
@@ -64,7 +64,7 @@ public SpecRelation(ILoggerFactory loggerFactory)
         /// Initializes a new instance of the <see cref="SpecRelation"/> class.
         /// </summary>
         /// <param name="reqIfContent">
-        /// The container <see cref="reqIfContent"/>
+        /// The container <see cref="ReqIFContent"/>
         /// </param>
         /// <param name="loggerFactory">
         /// The (injected) <see cref="ILoggerFactory"/> used to set up logging
diff --git a/ReqIFSharp/SpecElementWithAttributes/Specification.cs b/ReqIFSharp/SpecElementWithAttributes/Specification.cs
@@ -64,7 +64,7 @@ public Specification(ILoggerFactory loggerFactory)
         /// Initializes a new instance of the <see cref="Specification"/> class.
         /// </summary>
         /// <param name="reqIfContent">
-        /// The container <see cref="reqIfContent"/>
+        /// The container <see cref="ReqIFContent"/>
         /// </param>
         /// <param name="loggerFactory">
         /// The (injected) <see cref="ILoggerFactory"/> used to set up logging
diff --git a/ReqIFSharp/SpecType/SpecType.cs b/ReqIFSharp/SpecType/SpecType.cs
@@ -69,7 +69,7 @@ protected SpecType(ILoggerFactory loggerFactory)
         /// Initializes a new instance of the <see cref="SpecType"/> class.
         /// </summary>
         /// <param name="reqIfContent">
-        /// The owning <see cref="reqIfContent"/>
+        /// The owning <see cref="ReqIFContent"/>
         /// </param>
         /// <param name="loggerFactory">
         /// The (injected) <see cref="ILoggerFactory"/> used to set up logging
@@ -104,9 +104,6 @@ protected SpecType(ReqIFContent reqIfContent, ILoggerFactory loggerFactory)
         /// <param name="reader">
         /// an instance of <see cref="XmlReader"/>
         /// </param>
-        /// <param name="token">
-        /// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
-        /// </param>
         internal override void ReadXml(XmlReader reader)
         {
             base.ReadXml(reader);
