#27: Added version number to public api description of external packages

synergy-software · Dec 28, 2023 · 66de959 · 66de959
1 parent a8ded93
commit 66de959
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 5 deletions.
diff --git a/...ocumentation.Tests/Architecture/Public/Api.of.Synergy.Documentation.verified.md b/...ocumentation.Tests/Architecture/Public/Api.of.Synergy.Documentation.verified.md
@@ -6,7 +6,8 @@
      withAttributes: bool [Optional]
    ) : string
  - ApiDescription.GenerateFor(
-     assembly: Assembly
+     assembly: Assembly,
+     includeAssemblyVersion: bool [Optional]
    ) : string
  - ApiDescription.GenerateFor(
      types: IEnumerable<Type>,

diff --git a/Documentation/Synergy.Documentation.Tests/Architecture/Public/Package.cs b/Documentation/Synergy.Documentation.Tests/Architecture/Public/Package.cs
@@ -14,7 +14,7 @@ public async Task Generate(Type type)
         var assembly = type.Assembly;
 
         // ACT
-        var publicApi = ApiDescription.GenerateFor(assembly);
+        var publicApi = ApiDescription.GenerateFor(assembly, includeAssemblyVersion: true);
 
         // ASSERT
         await Verifier.Verify(publicApi, "md")

diff --git a/...rgy.Documentation.Tests/Architecture/Public/Package.of.Verify.Xunit.verified.md b/...rgy.Documentation.Tests/Architecture/Public/Package.of.Verify.Xunit.verified.md
@@ -1,4 +1,4 @@
-# Verify.Xunit
+# Verify.Xunit 1.0.0.0
 
 ## VerifyXunit.DerivePathInfo (class) : MulticastDelegate, ICloneable, ISerializable
  - Method: MethodInfo { get; }

diff --git a/...nergy.Documentation.Tests/Architecture/Public/Package.of.xunit.core.verified.md b/...nergy.Documentation.Tests/Architecture/Public/Package.of.xunit.core.verified.md
@@ -1,4 +1,4 @@
-# xunit.core
+# xunit.core 2.4.2.0
 
 ## Xunit.AssemblyTraitAttribute (attribute) : Attribute, ITraitAttribute
  - ctor(

diff --git a/Documentation/Synergy.Documentation/Api/ApiDescription.cs b/Documentation/Synergy.Documentation/Api/ApiDescription.cs
@@ -12,11 +12,14 @@ public static class ApiDescription
     {
         static readonly BindingFlags bindingFlags = BindingFlags.FlattenHierarchy | BindingFlags.Instance | BindingFlags.Static | BindingFlags.Public;
 
-        public static string GenerateFor(Assembly assembly)
+        public static string GenerateFor(Assembly assembly, bool includeAssemblyVersion = false)
         {
             var description = new StringBuilder();
 
             var assemblyName = assembly.GetName().Name;
+            if (includeAssemblyVersion)
+                assemblyName += " " + assembly.GetName().Version;
+
             description.AppendLine($"# {assemblyName}");
             description.AppendLine();