From 13e76de10387b99148fe4d66f36899abfa6dac96 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Pawe=C5=82=20=C5=81ukasik?= <lukasik.pawel+github@gmail.com>
Date: Sun, 14 Apr 2024 21:29:03 +0200
Subject: [PATCH] docs: Provide additional information about ResideInAssembly
 function

---
 ArchUnitNET/ArchUnitNET.csproj                             | 1 +
 ArchUnitNET/Fluent/Syntax/Elements/Types/GivenTypesThat.cs | 4 ++++
 2 files changed, 5 insertions(+)

diff --git a/ArchUnitNET/ArchUnitNET.csproj b/ArchUnitNET/ArchUnitNET.csproj
index cea267d4..226550ea 100644
--- a/ArchUnitNET/ArchUnitNET.csproj
+++ b/ArchUnitNET/ArchUnitNET.csproj
@@ -16,6 +16,7 @@
         <IncludeSymbols>true</IncludeSymbols>
         <SymbolPackageFormat>snupkg</SymbolPackageFormat>
         <PackageReadmeFile>README.md</PackageReadmeFile>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
     </PropertyGroup>
 
     <ItemGroup>
diff --git a/ArchUnitNET/Fluent/Syntax/Elements/Types/GivenTypesThat.cs b/ArchUnitNET/Fluent/Syntax/Elements/Types/GivenTypesThat.cs
index ec0035f0..68748778 100644
--- a/ArchUnitNET/Fluent/Syntax/Elements/Types/GivenTypesThat.cs
+++ b/ArchUnitNET/Fluent/Syntax/Elements/Types/GivenTypesThat.cs
@@ -183,6 +183,10 @@ public TGivenRuleTypeConjunction ResideInNamespace(
             return Create<TGivenRuleTypeConjunction, TRuleType>(_ruleCreator);
         }
 
+        /// <summary>Matches the types that reside in the assembly.</summary>
+        /// <param name="pattern">Name of the assembly to match.</param>
+        /// <param name="useRegularExpressions">Indicates if pattern shall be considered a regular expression.</param>
+        /// <remarks>In case of not using regular expression pattern has to be Assembly Full Name.</remarks>
         public TGivenRuleTypeConjunction ResideInAssembly(
             string pattern,
             bool useRegularExpressions = false