skip warnings for generated code

Author: saucecontrol

src/InheritDoc/CecilExtensions.cs

@@ -8,7 +8,11 @@
 
 internal static class CecilExtensions
 {
-	private const string compilerGeneratedAttribute = "System.Runtime.CompilerServices.CompilerGeneratedAttribute";
+	private static readonly string[] generatedCodeAttributes = [
+		"System.CodeDom.Compiler.GeneratedCodeAttribute",
+		"System.Diagnostics.DebuggerNonUserCodeAttribute",
+		"System.Runtime.CompilerServices.CompilerGeneratedAttribute"
+	];
 
 	// These are ignored as the base for types, defaulting the doc inheritance target to an implemented interface instead.
 	private static readonly string[] ignoredBaseTypes = [
@@ -66,9 +70,25 @@ public static IEnumerable<string> GetDocID(this MethodDefinition m)
 		return docID;
 	}
 
-	public static bool IsCompilerGenerated(this TypeDefinition t) => (t.HasCustomAttributes && t.CustomAttributes.Any(a => a.AttributeType.FullName == compilerGeneratedAttribute)) || (t.IsNested && t.DeclaringType.IsCompilerGenerated());
+	public static bool IsGeneratedCode(this TypeDefinition t) => (t.HasCustomAttributes && t.CustomAttributes.Any(a => generatedCodeAttributes.Contains(a.AttributeType.FullName))) || (t.IsNested && t.DeclaringType.IsGeneratedCode());
+
+	public static bool IsGeneratedCode(this MethodDefinition m)
+	{
+		if (m.HasCustomAttributes && m.CustomAttributes.Any(a => generatedCodeAttributes.Contains(a.AttributeType.FullName)))
+			return true;
+
+		if (m.IsPropertyMethod())
+			return getPropertyForMethod(m).IsGeneratedCode();
+
+		if (m.IsEventMethod())
+			return getEventForMethod(m).IsGeneratedCode();
+
+		return m.DeclaringType.IsGeneratedCode();
+	}
+
+	public static bool IsGeneratedCode(this EventDefinition e) => e.HasCustomAttributes && e.CustomAttributes.Any(a => generatedCodeAttributes.Contains(a.AttributeType.FullName)) || e.DeclaringType.IsGeneratedCode();
 
-	public static bool IsCompilerGenerated(this MethodDefinition m) => m.HasCustomAttributes && m.CustomAttributes.Any(a => a.AttributeType.FullName == compilerGeneratedAttribute);
+	public static bool IsGeneratedCode(this PropertyDefinition p) => p.HasCustomAttributes && p.CustomAttributes.Any(a => generatedCodeAttributes.Contains(a.AttributeType.FullName)) || p.DeclaringType.IsGeneratedCode();
 
 	public static bool IsNamespaceDocPlaceholder(this TypeDefinition t) => t.Name == "NamespaceDoc";
 

src/InheritDoc/InheritDocProcessor.cs

@@ -35,6 +35,7 @@ private static class DocAttributeNames
 	{
 		public static readonly XName _visited = XName.Get(nameof(_visited));
 		public static readonly XName _trimmed = XName.Get(nameof(_trimmed));
+		public static readonly XName _gencode = XName.Get(nameof(_gencode));
 		public static readonly XName Cref = XName.Get("cref");
 		public static readonly XName Name = XName.Get("name");
 		public static readonly XName Path = XName.Get("path");
@@ -89,7 +90,6 @@ static XDocument loadDoc(string path)
 			asm.Modules
 			.SelectMany(m => m.Types)
 			.SelectManyRecursive(t => t.NestedTypes)
-			.Where(t => !t.IsCompilerGenerated() || t.IsNamespaceDocPlaceholder())
 			.ToList()
 		;
 
@@ -107,8 +107,14 @@ static XDocument loadDoc(string path)
 		while ((mem = docMembers.Elements(DocElementNames.Member).FirstOrDefault(isInheritDocCandidate)) is not null)
 			replaceInheritDoc(docPath, mem, docMap, docMembers, refDocs, logger);
 
-		foreach (var md in docMembers.Elements(DocElementNames.Member).Where(m => m.HasAttribute(DocAttributeNames._visited)))
-			md.SetAttributeValue(DocAttributeNames._visited, null);
+		foreach (var md in docMembers.Elements(DocElementNames.Member))
+		{
+			if (md.HasAttribute(DocAttributeNames._visited))
+				md.SetAttributeValue(DocAttributeNames._visited, null);
+
+			if (md.HasAttribute(DocAttributeNames._gencode))
+				md.SetAttributeValue(DocAttributeNames._gencode, null);
+		}
 
 		if (trimLevel > ApiLevel.None)
 		{
@@ -143,14 +149,20 @@ private static IDictionary<string, IEnumerable<DocMatch>> generateDocMap(IList<T
 			string typeID = t.GetDocID();
 			var memDocs = findDocsByID(docMembers, typeID);
 
-			// Several tools include this hack to output namespace documentation
-			// https://stackoverflow.com/questions/793210/xml-documentation-for-a-namespace
-			if (t.IsCompilerGenerated() && t.IsNamespaceDocPlaceholder())
+			if (t.IsGeneratedCode())
 			{
-				foreach (var md in memDocs)
-					md.SetAttributeValue(DocAttributeNames.Name, "N:" + t.Namespace);
+				// Several tools include this hack to output namespace documentation
+				// https://stackoverflow.com/questions/793210/xml-documentation-for-a-namespace
+				if (t.IsNamespaceDocPlaceholder())
+				{
+					foreach (var md in memDocs)
+						md.SetAttributeValue(DocAttributeNames.Name, "N:" + t.Namespace);
 
-				continue;
+					continue;
+				}
+
+				foreach (var md in memDocs)
+					md.SetAttributeValue(DocAttributeNames._gencode, true);
 			}
 
 			if (t.GetApiLevel() <= trimLevel)
@@ -183,7 +195,7 @@ private static IDictionary<string, IEnumerable<DocMatch>> generateDocMap(IList<T
 					dml.Add(new DocMatch(cref, t));
 			}
 
-			foreach (var (m, idx, memID) in t.Methods.Where(m => !m.IsCompilerGenerated() || m.IsEventMethod() || m.IsPropertyMethod()).SelectMany(m => m.GetDocID().Select((d, i) => (m, i, d))))
+			foreach (var (m, idx, memID) in t.Methods.SelectMany(m => m.GetDocID().Select((d, i) => (m, i, d))))
 			{
 				if (docMap.ContainsKey(memID))
 					continue;
@@ -209,6 +221,12 @@ private static IDictionary<string, IEnumerable<DocMatch>> generateDocMap(IList<T
 						md.SetAttributeValue(DocAttributeNames._trimmed, true);
 				}
 
+				if (m.IsGeneratedCode())
+				{
+					foreach (var md in methDocs)
+						md.SetAttributeValue(DocAttributeNames._gencode, true);
+				}
+
 				if (methDocs.Descendants(DocElementNames.InheritDoc).Any())
 				{
 					logger.Write(ILogger.Severity.Diag, "Processing DocID: " + memID);
@@ -257,7 +275,7 @@ private static void replaceInheritDoc(string file, XElement mem, IDictionary<str
 			string? cref = (string)inh.Attribute(DocAttributeNames.Cref) ?? dml?.FirstOrDefault()?.Cref;
 			if (string.IsNullOrEmpty(cref))
 			{
-				if (!mem.HasAttribute(DocAttributeNames._trimmed))
+				if (!mem.HasAttribute(DocAttributeNames._trimmed) && !mem.HasAttribute(DocAttributeNames._gencode))
 					logger.Warn(ErrorCodes.NoBase, file, mem.SourceLine(), mem.SourceColumn(), "Cref not present and no base could be found for: " + memID);
 
 				continue;
@@ -275,7 +293,7 @@ private static void replaceInheritDoc(string file, XElement mem, IDictionary<str
 			doc = findDocsByID(members, cref!).FirstOrDefault();
 			if (doc is null)
 			{
-				if (!mem.HasAttribute(DocAttributeNames._trimmed))
+				if (!mem.HasAttribute(DocAttributeNames._trimmed) && !mem.HasAttribute(DocAttributeNames._gencode))
 					logger.Warn(ErrorCodes.NoDocs, file, mem.SourceLine(), mem.SourceColumn(), "No matching documentation could be found for: " + memID + ", which attempts to inherit from: " + cref);
 
 				continue;
@@ -364,7 +382,7 @@ static void removeDoc(List<XNode> nodes, int pos)
 		if (nodes.Count > 0 && nodes[0].IsWhiteSpace())
 			nodes.RemoveAt(0);
 
-		if (nodes.Count == 0 && !inh.Ancestors(DocElementNames.Member).Any(m => m.HasAttribute(DocAttributeNames._trimmed)))
+		if (nodes.Count == 0 && !inh.Ancestors(DocElementNames.Member).Any(m => m.HasAttribute(DocAttributeNames._trimmed) || m.HasAttribute(DocAttributeNames._gencode)))
 			logger.Warn(ErrorCodes.NoNode, file, inh.SourceLine(), inh.SourceColumn(), "No matching non-duplicate nodes found for: " + memID + ", which attempts to inherit from: " + dm.Cref + " path=\"" + xpath + "\"");
 		else
 			inh.ReplaceWith(nodes);