IsPackable set via Directory.Build.props

mycsharp · May 17, 2021 · 5b8213f · 5b8213f
1 parent 8d183cb
commit 5b8213f
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 7 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,19 +1,24 @@
 <Project>
     <PropertyGroup>
         <MinClientVersion>2.12</MinClientVersion>
-        <GenerateDocumentationFile Condition=" '$(Configuration)' == 'Release' ">true</GenerateDocumentationFile>
         <Authors>MyCSharp.de, Benjamin Abt, Günther Foidl and Contributors</Authors>
         <PackageProjectUrl>https://github.com/mycsharp/HttpUserAgentParser</PackageProjectUrl>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
         <DefaultLanguage>en-US</DefaultLanguage>
-        <IsTestProject>$(MSBuildProjectName.Contains('Test'))</IsTestProject>
         <Description>HTTP User Agent Parser for .NET</Description>
         <NoPackageAnalysis>true</NoPackageAnalysis>
         <LangVersion>preview</LangVersion>
         <Nullable>enable</Nullable>
         <EmbedUntrackedSources>true</EmbedUntrackedSources>
         <PublishRepositoryUrl>true</PublishRepositoryUrl>
         <DebugType>embedded</DebugType>
+        <IsTestProject>$(MSBuildProjectName.Contains('Test'))</IsTestProject>
+        <IsBenchmarkProject>$(MsBuildProjectName.Contains('Benchmark'))</IsBenchmarkProject>
         <IsPackable>false</IsPackable>
     </PropertyGroup>
+
+    <PropertyGroup Condition="'$(IsTestProject)' != 'true' AND '$(IsBenchmarkProject)' != 'true'">
+        <IsPackable>true</IsPackable>
+        <GenerateDocumentationFile Condition="'$(Configuration)' == 'Release'">true</GenerateDocumentationFile>
+    </PropertyGroup>
 </Project>
diff --git a/src/MyCSharp.HttpUserAgentParser.AspNetCore/MyCSharp.HttpUserAgentParser.AspNetCore.csproj b/src/MyCSharp.HttpUserAgentParser.AspNetCore/MyCSharp.HttpUserAgentParser.AspNetCore.csproj
@@ -4,7 +4,6 @@
         <Product>HTTP User Agent Parser Extensions for ASP.NET Core</Product>
         <Description>HTTP User Agent Parser Extensions for ASP.NET Core</Description>
         <TargetFramework>net5.0</TargetFramework>
-        <IsPackable>true</IsPackable>
     </PropertyGroup>
 
     <ItemGroup>

diff --git a/src/MyCSharp.HttpUserAgentParser.MemoryCache/HttpUserAgentParserMemoryCachedProvider.cs b/src/MyCSharp.HttpUserAgentParser.MemoryCache/HttpUserAgentParserMemoryCachedProvider.cs
@@ -6,6 +6,7 @@
 
 namespace MyCSharp.HttpUserAgentParser.MemoryCache
 {
+    /// <inheritdoc/>
     public class HttpUserAgentParserMemoryCachedProvider : IHttpUserAgentParserProvider
     {
         private readonly IMemoryCache _memoryCache;
@@ -17,6 +18,7 @@ public HttpUserAgentParserMemoryCachedProvider(IMemoryCache memoryCache, HttpUse
             _options = options;
         }
 
+        /// <inheritdoc/>
         public HttpUserAgentInformation Parse(string userAgent)
         {
             CacheKey key = this.GetKey(userAgent);

diff --git a/src/MyCSharp.HttpUserAgentParser.MemoryCache/MyCSharp.HttpUserAgentParser.MemoryCache.csproj b/src/MyCSharp.HttpUserAgentParser.MemoryCache/MyCSharp.HttpUserAgentParser.MemoryCache.csproj
@@ -4,7 +4,6 @@
         <Product>HTTP User Agent Parser Extensions for IMemoryCache</Product>
         <Description>HTTP User Agent Parser Extensions for IMemoryCache</Description>
         <TargetFramework>netstandard2.1</TargetFramework>
-        <IsPackable>true</IsPackable>
     </PropertyGroup>
 
     <ItemGroup>

diff --git a/src/MyCSharp.HttpUserAgentParser/MyCSharp.HttpUserAgentParser.csproj b/src/MyCSharp.HttpUserAgentParser/MyCSharp.HttpUserAgentParser.csproj
@@ -4,7 +4,6 @@
         <Product>HTTP User Agent Parser</Product>
         <Description>Parses user agents for Browser, Platform and Bots.</Description>
         <TargetFramework>netstandard2.1</TargetFramework>
-        <IsPackable>true</IsPackable>
     </PropertyGroup>
 
     <ItemGroup>

diff --git a/src/MyCSharp.HttpUserAgentParser/Providers/IHttpUserAgentParserProvider.cs b/src/MyCSharp.HttpUserAgentParser/Providers/IHttpUserAgentParserProvider.cs
@@ -1,9 +1,17 @@
-// Copyright © myCSharp 2020-2021, all rights reserved
+// Copyright © myCSharp 2020-2021, all rights reserved
 
 namespace MyCSharp.HttpUserAgentParser.Providers
 {
+    /// <summary>
+    /// Provides the basic parsing of user agent strings.
+    /// </summary>
     public interface IHttpUserAgentParserProvider
     {
+        /// <summary>
+        /// Parsed the <paramref name="userAgent"/>-string.
+        /// </summary>
+        /// <param name="userAgent">The user agent to parse.</param>
+        /// <returns>The parsed user agent information</returns>
         HttpUserAgentInformation Parse(string userAgent);
     }
-}
+}