handle inheritance with primary constructors

saucecontrol · Nov 26, 2023 · d43b5b5 · d43b5b5
1 parent 391b8a2
commit d43b5b5
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 4 deletions.
diff --git a/src/InheritDoc/InheritDoc.csproj b/src/InheritDoc/InheritDoc.csproj
@@ -2,7 +2,7 @@
 
 	<PropertyGroup>
 		<VersionPrefix>1.4.0</VersionPrefix>
-		<TargetFrameworks>netstandard2.0;net462</TargetFrameworks>
+		<TargetFrameworks>netstandard2.0;net46</TargetFrameworks>
 	</PropertyGroup>
 
 	<PropertyGroup>

diff --git a/src/InheritDoc/InheritDocProcessor.cs b/src/InheritDoc/InheritDocProcessor.cs
@@ -230,9 +230,18 @@ private static IDictionary<string, IEnumerable<DocMatch>> generateDocMap(IList<T
 					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 dml = new List<DocMatch>();
+					var bases = (om is not null ? (new[] { om }) : [ ]).Concat(m.GetBaseCandidates()).ToList();
 
-					var bases = (om is not null ? (new[] { om }) : [ ]).Concat(m.GetBaseCandidates());
+					// With C# primary constructors, the constructor does not have docs of its own. If we don't have a base
+					// or cref for a constructor, inject its declaring type as a cref so we don't warn about a missing base.
+					if (m.IsConstructor && bases.Count == 0 && crefs.Count == 0)
+					{
+						crefs.Add(m.DeclaringType.GetDocID());
+						foreach (var d in methDocs.Descendants(DocElementNames.InheritDoc))
+							d.SetElementValue(DocAttributeNames.Cref, m.DeclaringType.GetDocID());
+					}
+
+					var dml = new List<DocMatch>();
 					foreach (var (bm, cref) in bases.SelectMany(bm => bm.GetDocID().Select(d => (bm, d))))
 					{
 						if (dml.Count == 0 || crefs.Contains(cref))

diff --git a/src/InheritDoc/package/build/SauceControl.InheritDoc.props b/src/InheritDoc/package/build/SauceControl.InheritDoc.props
@@ -2,7 +2,7 @@
 <Project>
 
 	<PropertyGroup>
-		<_InheritDocTaskTfm Condition="'$(MSBuildRuntimeType)'!='Core'">net462</_InheritDocTaskTfm>
+		<_InheritDocTaskTfm Condition="'$(MSBuildRuntimeType)'!='Core'">net46</_InheritDocTaskTfm>
 		<_InheritDocTaskTfm Condition="'$(MSBuildRuntimeType)'=='Core'">netstandard2.0</_InheritDocTaskTfm>
 		<_InheritDocTaskLib>$(MSBuildThisFileDirectory)..\tools\$(_InheritDocTaskTfm)\SauceControl.InheritDoc.dll</_InheritDocTaskLib>
 		<_InheritDocNetStandardFallback>$(MSBuildThisFileDirectory)..\tools\netstandard.xml.gz</_InheritDocNetStandardFallback>

diff --git a/tests/InheritDoc.Test/DocTests.cs b/tests/InheritDoc.Test/DocTests.cs
@@ -258,6 +258,16 @@ private GII() { }
 	unsafe public T[] M<T>(T* tp) where T : unmanaged => default;
 }
 
+/// <inheritdoc />
+/// <param name="s">Param s</param>
+public class PC(string s) : GGI
+{
+	new internal const string T_ID = nameof(PC);
+	internal const string M_ID_ctor = T_ID + ".#ctor(" + nameof(System) + "." + nameof(String) + ")";
+
+	string S => s;
+}
+
 /// <summary>
 ///     Class W
 ///     <see cref="B" />

diff --git a/tests/InheritDoc.Test/InheritDocTests.cs b/tests/InheritDoc.Test/InheritDocTests.cs
@@ -265,6 +265,13 @@ public void WhitespacePreserved()
 		Assert.IsTrue(ele?.NextNode?.IsWhiteSpace() ?? false);
 	}
 
+	[TestMethod]
+	public void PrimaryConstructorInheritsFromType()
+	{
+		var ele = getDocElement("M:" + PC.M_ID_ctor, "summary");
+		Assert.AreEqual("Class G ", ele?.Value);
+	}
+
 	[TestMethod]
 	public void InternalMembersTrimmed()
 	{