v1.3.0

saucecontrol · May 7, 2021 · b6933b0 · b6933b0
1 parent 140d7c8
commit b6933b0
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 25 deletions.
diff --git a/build/Common.props b/build/Common.props
@@ -6,7 +6,6 @@
 		<RepositoryUrl>https://github.com/saucecontrol/InheritDoc</RepositoryUrl>
 		<Copyright>Copyright © 2019-$([System.DateTime]::Today.Year) $(Authors)</Copyright>
 		<Title>Automatic Documentation Inheritance Processing</Title>
-		<Description>Automatically replace &lt;inheritdoc /&gt; tags with inherited documentation at build time.  Integrates with MSBuild, so no command line tool or VS add-on is required.</Description>
 
 		<RootNamespace>$(MSBuildProjectName)</RootNamespace>
 		<AssemblyName>$(Owners).$(MSBuildProjectName)</AssemblyName>
@@ -18,6 +17,7 @@
 		<PackageProjectUrl>$(RepositoryUrl)</PackageProjectUrl>
 		<PackageTags>Inherit, XML, Documentation, Comments, MSBuild</PackageTags>
 		<PackageReleaseNotes>See $(RepositoryUrl)/releases for release-specific notes.</PackageReleaseNotes>
+		<PackageDescription>Automatically replace &lt;inheritdoc /&gt; tags with inherited documentation at build time.  Integrates with MSBuild, so no command line tool or VS add-on is required.</PackageDescription>
 
 		<LangVersion>9</LangVersion>
 		<Features>strict</Features>

diff --git a/license b/license
@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2019 Clinton Ingram
+Copyright (c) 2019-2021 Clinton Ingram and Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/readme.md b/readme.md
@@ -224,11 +224,11 @@ InheritDoc is enabled by default for all non-debug builds.  It can be enabled or
 </PropertyGroup>
 ```
 
-Alternatively, you can conditionally incude the NuGet package only for specific configurations.
+Alternatively, you can conditionally include the NuGet package only for specific configurations.
 
 ```XML
-<ItemGroup Condition="'$(Configuration)'!='Dist'">
-    <PackageReference Include="SauceControl.InheritDoc" Version="1.2.0" PrivateAssets="all" />
+<ItemGroup Condition="'$(Configuration)'=='Dist'">
+    <PackageReference Include="SauceControl.InheritDoc" Version="1.*" PrivateAssets="all" />
 </ItemGroup>
 ```
 
@@ -257,25 +257,6 @@ InheritDoc will automatically discover XML documentation files alongside assembl
 </ItemGroup>
 ```
 
-#### Disabling InheritDoc Build Warnings
-
-Warnings can be selectively disabled with the MSBuild standard `NoWarn` property.  For example:
-
-```XML
-<PropertyGroup Condition="'$(TargetFramework)'=='netstandard2.0'">
-    <NoWarn>$(NoWarn);IDT001</NoWarn>
-</PropertyGroup>
-```
-
-#### Possible Warnings
-
-| Code | Description |
-|------|-------------|
-|IDT001| Indicates a referenced XML documentation file could not be loaded or parsed or that the file did not contain documentation in the standard schema. |
-|IDT002| Indicates incomplete XML docs for the target assembly or one of its external references. i.e. an inheritance candidate was identified but had no documentaion to inherit. |
-|IDT003| May indicate you used `<inheritdoc />` on a type/member with no identifiable base. You may correct this warning by using the `cref` attribute to identify the base explicitly. |
-|IDT004| May indicate an incorrect XPath value in a `path` attribute or a duplicate/superfluous or self-referencing `<inheritdoc />` tag. |
-
 #### Using InheritDoc With Multi-Targeted Projects
 
 If you are multi-targeting using the new(er) SDK-style projects and the `TargetFrameworks` property, you must ensure that you are not generating multiple XML documentation outputs to the same file path.
@@ -288,7 +269,7 @@ If you configure the XML documentation output from the project property page in
 </PropertyGroup>
 ```
 
-The above configuration will create a single `MyProject.xml` file in your project root for all target frameworks and all build configurations.  Since MSBuild builds multiple target framework outputs in parallel there will be a race condition for access to that file.
+The above configuration will create a single `MyProject.xml` file in your project root for all target frameworks and all build configurations.  Since the dotnet build server builds multiple target framework outputs in parallel there will be a race condition for access to that file.
 
 The simpler configuration, supported in all multi-targeting capable SDK versions, is:
 
@@ -300,6 +281,25 @@ The simpler configuration, supported in all multi-targeting capable SDK versions
 
 This will automatically name your XML file with the same base as the assembly name and will create it in the correct `obj` folder alongside the assembly.
 
+#### Disabling InheritDoc Build Warnings
+
+Warnings can be selectively disabled with the MSBuild standard `NoWarn` property.  For example:
+
+```XML
+<PropertyGroup Condition="'$(TargetFramework)'=='netstandard2.0'">
+    <NoWarn>$(NoWarn);IDT001</NoWarn>
+</PropertyGroup>
+```
+
+#### Possible Warnings
+
+| Code | Description |
+|------|-------------|
+|IDT001| Indicates a referenced XML documentation file could not be loaded or parsed or that the file did not contain documentation in the standard schema. |
+|IDT002| Indicates incomplete XML docs for the target assembly or one of its external references. i.e. an inheritance candidate was identified but had no documentaion to inherit. |
+|IDT003| May indicate you used `<inheritdoc />` on a type/member with no identifiable base. You may correct this warning by using the `cref` attribute to identify the base explicitly. |
+|IDT004| May indicate an incorrect XPath value in a `path` attribute or a duplicate/superfluous or self-referencing `<inheritdoc />` tag. |
+
 Known Issues
 ------------