v2.0

.gitignore

@@ -1,6 +1,2 @@
 .vs
-bin
-obj
 out
-TestResults
-BenchmarkDotNet.Artifacts

build/Common.props

@@ -4,7 +4,7 @@
 		<Owners>SauceControl</Owners>
 		<Authors>Clinton Ingram</Authors>
 		<RepositoryUrl>https://github.com/saucecontrol/InheritDoc</RepositoryUrl>
-		<Copyright>Copyright © 2019-$([System.DateTime]::Today.Year) $(Authors)</Copyright>
+		<Copyright>Copyright © 2019-$([System.DateTime]::Today.Year) $(Authors) and Contributors</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>
 
@@ -13,7 +13,7 @@
 		<AssemblyTitle>$(MSBuildProjectName)</AssemblyTitle>
 		<Product>$(MSBuildProjectName)</Product>
 
-		<PackageIcon>$(Owners).png</PackageIcon>
+		<PackageIcon>icon.png</PackageIcon>
 		<PackageReadmeFile>readme.md</PackageReadmeFile>
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<PackageProjectUrl>$(RepositoryUrl)</PackageProjectUrl>
@@ -57,8 +57,8 @@
 	</PropertyGroup>
 
 	<ItemGroup Condition="'$(Configuration)'=='Dist' Or '$(Configuration)'=='Coverage'">
-		<None Include="$(MSBuildThisFileDirectory)$(Owners).png" Pack="true" PackagePath="/" />
-		<None Include="$(ProjectRoot)readme.md" Pack="true" PackagePath="/" />
+		<None Include="$(MSBuildThisFileDirectory)$(PackageIcon)" Pack="true" PackagePath="/" />
+		<None Include="$(ProjectRoot)$(PackageReadmeFile)" Pack="true" PackagePath="/" />
 		<None Include="$(RepositoryRoot)license" Pack="true" PackagePath="/" />
 		<None Include="$(RepositoryRoot)third-party-notices" Pack="true" PackagePath="/" />
 		<SourceRoot Include="$(RepositoryRoot)" />

src/InheritDoc/InheritDocProcessor.cs

@@ -226,34 +226,30 @@ private static IDictionary<string, IEnumerable<DocMatch>> generateDocMap(IList<T
 						md.SetAttributeValue(DocAttributeNames._gencode, true);
 				}
 
-				if (methDocs.Descendants(DocElementNames.InheritDoc).Any())
+				if (methDocs.Any() && (m.IsConstructor || methDocs.Descendants(DocElementNames.InheritDoc).Any()))
 				{
-					logger.Write(ILogger.Severity.Diag, "Processing DocID: " + memID);
-
-					var crefs = methDocs.Descendants(DocElementNames.InheritDoc).Select(i => (string)i.Attribute(DocAttributeNames.Cref)).Where(c => !string.IsNullOrWhiteSpace(c)).ToHashSet();
-					var bases = (om is not null ? (new[] { om }) : [ ]).Concat(m.GetBaseCandidates()).ToList();
-
-					// Fix up docs for C# primary constructors, which do not have docs of their own and therefore should not get warnings for missing base.
-					if (m.IsConstructor && bases.Count == 0 && crefs.Count == 0 && memDocs.Any())
+					// Fix up docs for C# primary constructors, which result in type and constructor sharing docs.
+					if (m.IsConstructor && memDocs.Any())
 					{
 						var typeDoc = memDocs.First();
 						var ctorDoc = methDocs.First();
 						ctorDoc.SetAttributeValue(DocAttributeNames.Name, typeID);
 
-						// Type and constructor having identical docs is the surest sign of a primary constructor.
-						// We'll find a suitable base for the ctor and inject a cref pointing to it.
 						if (nodeComparer.Equals(typeDoc, ctorDoc))
 						{
-							string cref = typeID;
-							if (m.GetBaseConstructor() is MethodDefinition bc && bc.GetDocID().SelectMany(d => findDocsByID(docMembers, d)).FirstOrDefault() is XElement bcd)
-								cref = (string)bcd.Attribute(DocAttributeNames.Name);
+							// Find a suitable base for the ctor and inject a cref in order to avoid warning for missing base.
+							if (ctorDoc.Elements(DocElementNames.InheritDoc).Any())
+							{
+								string cref = typeID;
+								if (m.GetBaseConstructor() is MethodDefinition bc && bc.GetDocID().SelectMany(d => findDocsByID(docMembers, d)).FirstOrDefault() is XElement bcd)
+									cref = (string)bcd.Attribute(DocAttributeNames.Name);
 
-							crefs.Add(cref);
-							foreach (var d in methDocs.Descendants(DocElementNames.InheritDoc))
-								d.SetElementValue(DocAttributeNames.Cref, cref);
+								foreach (var d in ctorDoc.Elements(DocElementNames.InheritDoc).Where(i => !i.HasAttribute(DocAttributeNames.Cref)))
+									d.SetAttributeValue(DocAttributeNames.Cref, cref);
+							}
 
-							// `param` elements meant for the constructor will also appear in the type's docs.
-							foreach (var param in typeDoc.Descendants(DocElementNames.Param).ToList())
+							// Remove `param` elements meant for the constructor, which also appear in the type's docs.
+							foreach (var param in typeDoc.Elements(DocElementNames.Param).ToList())
 							{
 								if ((param.PreviousNode?.IsWhiteSpace()).GetValueOrDefault())
 									param.PreviousNode!.Remove();
@@ -265,23 +261,31 @@ private static IDictionary<string, IEnumerable<DocMatch>> generateDocMap(IList<T
 						ctorDoc.SetAttributeValue(DocAttributeNames.Name, memID);
 					}
 
-					var dml = new List<DocMatch>();
-					foreach (var (bm, cref) in bases.SelectMany(bm => bm.GetDocID().Select(d => (bm, d))))
+					if (methDocs.Descendants(DocElementNames.InheritDoc).Any())
 					{
-						if (dml.Count == 0 || crefs.Contains(cref))
-							dml.Add(new DocMatch(cref, m, bm));
+						logger.Write(ILogger.Severity.Diag, "Processing DocID: " + memID);
 
-						if (crefs.Count == 0)
-							break;
-					}
+						var bases = (om is not null ? (new[] { om }) : []).Concat(m.GetBaseCandidates()).ToList();
+						var crefs = methDocs.Descendants(DocElementNames.InheritDoc).Select(i => (string)i.Attribute(DocAttributeNames.Cref)).Where(c => !string.IsNullOrWhiteSpace(c)).ToHashSet();
+						var dml = new List<DocMatch>();
 
-					foreach (var cref in crefs.Where(c => !dml.Any(dm => dm.Cref == c)))
-						dml.Add(new DocMatch(cref, m));
+						foreach (var (bm, cref) in bases.SelectMany(bm => bm.GetDocID().Select(d => (bm, d))))
+						{
+							if (dml.Count == 0 || crefs.Contains(cref))
+								dml.Add(new DocMatch(cref, m, bm));
 
-					if (dml.Count > 0)
-						docMap.Add(memID, dml);
-					else
-						logger.Write(ILogger.Severity.Info, "No inherit candidate for: " + memID);
+							if (crefs.Count == 0)
+								break;
+						}
+
+						foreach (var cref in crefs.Where(c => !dml.Any(dm => dm.Cref == c)))
+							dml.Add(new DocMatch(cref, m));
+
+						if (dml.Count > 0)
+							docMap.Add(memID, dml);
+						else
+							logger.Write(ILogger.Severity.Info, "No inherit candidate for: " + memID);
+					}
 				}
 			}
 

tests/InheritDoc.Test/InheritDoc.Test.csproj

@@ -7,7 +7,7 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.2" />
+		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
 		<PackageReference Include="MSTest.TestAdapter" Version="3.1.1" />
 		<PackageReference Include="MSTest.TestFramework" Version="3.1.1" />
 	</ItemGroup>