Skip to content

Commit 7a6d9de

Browse files
committed
Cleaned up package descriptions.
1 parent 2b66944 commit 7a6d9de

File tree

7 files changed

+21
-18
lines changed

7 files changed

+21
-18
lines changed

Biohazrd.CSharp/Biohazrd.CSharp.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<PropertyGroup>
44
<TargetFramework>net5.0</TargetFramework>
5-
<PackageDescription>$(PackageDescription) — Transformations and binding generation for C#</PackageDescription>
5+
<PackageDescription>This package provides transformations and binding generation for C#.</PackageDescription>
66
</PropertyGroup>
77

88
<ItemGroup>

Biohazrd.OutputGeneration/Biohazrd.OutputGeneration.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<PropertyGroup>
44
<TargetFramework>net5.0</TargetFramework>
5-
<PackageDescription>$(PackageDescription) — Language-agnostic functionality for writing out code and other files</PackageDescription>
5+
<PackageDescription>This package provides language-agnostic functionality for writing out code and other files.</PackageDescription>
66
</PropertyGroup>
77

88
<ItemGroup>

Biohazrd.Transformation/Biohazrd.Transformation.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<PropertyGroup>
44
<TargetFramework>net5.0</TargetFramework>
5-
<PackageDescription>$(PackageDescription) — Language-agnostic functionality for manipulating declaration trees</PackageDescription>
5+
<PackageDescription>This package provides language-agnostic functionality for manipulating declaration trees.</PackageDescription>
66
</PropertyGroup>
77

88
<ItemGroup>

Biohazrd.Utilities/Biohazrd.Utilities.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<PropertyGroup>
44
<TargetFramework>net5.0</TargetFramework>
5-
<PackageDescription>$(PackageDescription) — Language-agnostic helpers</PackageDescription>
5+
<PackageDescription>This package provides various language-agnostic helpers for Biohazrd generators.</PackageDescription>
66
</PropertyGroup>
77

88
<ItemGroup>

Biohazrd/Biohazrd.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<TargetFramework>net5.0</TargetFramework>
55
<!-- The Biohazrd package is an all-in-one package which brings in everything so we need to disambiguate this one. -->
66
<PackageId>Biohazrd.Core</PackageId>
7-
<PackageDescription>$(PackageDescriptionPrefix)This package provides core functionality for parsing and representing C/C++.</PackageDescription>
7+
<PackageDescription>This package provides core functionality for parsing C/C++ libraries.</PackageDescription>
88
</PropertyGroup>
99

1010
<ItemGroup>

tooling/Common.csproj.props

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,6 @@
1515
<Authors>David Maas and Contributors</Authors>
1616
<Copyright>Copyright David Maas and Contributors</Copyright>
1717
<Product>Biohazrd</Product>
18-
19-
<!-- This dummy description is used to error when the description is missing -->
20-
<PackageDescription>PACKAGE_DESCRIPTION_MISSING</PackageDescription>
21-
<PackageDescription>A framework for automatically generating bindings for C/C++ libraries</PackageDescription>
22-
<PackageDescriptionPrefix>A framework for automatically generating bindings for C/C++ libraries.&#10;&#10;</PackageDescriptionPrefix>
2318

2419
<!-- Ignore warnings about stable packages referencing pre-release ones. -->
2520
<NoWarn>$(NoWarn);NU5104</NoWarn>

tooling/Common.csproj.targets

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,6 @@
1616
<Target Name="EnsureCiBuildsHaveVersion" BeforeTargets="Build;Pack" Condition="'$(ContinuousIntegrationBuild)' == 'true' and '$(CiBuildVersion)' == ''">
1717
<Error Text="ContinuousIntegrationBuild is enabled without specifying version number!" />
1818
</Target>
19-
20-
<!-- Ensure packages have descriptions -->
21-
<Target Name="EnsurePackagesHaveDescriptions" BeforeTargets="GenerateNuspec" Condition="'$(IsPackable)' == 'true' and '$(PackageDescription)' == 'PACKAGE_DESCRIPTION_MISSING'">
22-
<Error Text="$(AssemblyName) does not have a PackageDescription!" />
23-
</Target>
24-
<Target Name="EnsurePackagesHaveDescriptionsBeforeBuild" BeforeTargets="Build" Condition="'$(IsPackable)' == 'true' and '$(PackageDescription)' == 'PACKAGE_DESCRIPTION_MISSING'">
25-
<Warning Text="$(AssemblyName) does not have a PackageDescription!" />
26-
</Target>
2719

2820
<!-- Use the informational version (which includes the Git revision) for the package version -->
2921
<Target Name="UseInformationalVersionForPackageVersion" BeforeTargets="GenerateNuspec;_GetOutputItemsFromPack" DependsOnTargets="AddSourceRevisionToInformationalVersion">
@@ -32,4 +24,20 @@
3224
<PackageVersion>$(InformationalVersion)</PackageVersion>
3325
</PropertyGroup>
3426
</Target>
27+
28+
<!-- Add common package description blurb to all packages -->
29+
<PropertyGroup>
30+
<CommonPackageDescription>A framework for automatically generating bindings for C/C++ libraries.</CommonPackageDescription>
31+
<PackageDescription Condition="'$(PackageDescription)' != ''">$(CommonPackageDescription)&#10;&#10;$(PackageDescription)</PackageDescription>
32+
<PackageDidNotSpecifyCustomDescription Condition="'$(PackageDescription)' == ''">true</PackageDidNotSpecifyCustomDescription>
33+
<PackageDescription Condition="'$(PackageDescription)' == ''">$(CommonPackageDescription)</PackageDescription>
34+
</PropertyGroup>
35+
36+
<!-- Ensure all specific packages have specific descriptions -->
37+
<Target Name="EnsurePackageHasSpecificDescription" BeforeTargets="GenerateNuspec" Condition="'$(IsPackable)' == 'true' and '$(PackageDidNotSpecifyCustomDescription)' == 'true' and '$(AssemblyName)' != 'Biohazrd.AllInOne'">
38+
<Error Text="$(AssemblyName) does not have a PackageDescription!" />
39+
</Target>
40+
<Target Name="EnsurePackageHasSpecificDescriptionBeforeBuild" BeforeTargets="Build" Condition="'$(IsPackable)' == 'true' and '$(PackageDidNotSpecifyCustomDescription)' == 'true'and '$(AssemblyName)' != 'Biohazrd.AllInOne'">
41+
<Warning Text="$(AssemblyName) does not have a PackageDescription!" />
42+
</Target>
3543
</Project>

0 commit comments

Comments
 (0)