docs: Provide additional information about ResideInAssembly function

Signed-off-by: Paweł Łukasik <[email protected]>
TNG · Apr 15, 2024 · 62a80fe · 62a80fe
1 parent 98f7f0e
commit 62a80fe
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git 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
@@ -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