fix(generator): inheritdoc on task methods, settings classes, extensi…

…ons classes
nuke-build · Dec 4, 2024 · dd017b1 · dd017b1
1 parent 56d3675
commit dd017b1
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 5 deletions.
diff --git a/source/Nuke.Tooling.Generator/Generators/TaskGenerator.cs b/source/Nuke.Tooling.Generator/Generators/TaskGenerator.cs
@@ -120,8 +120,7 @@ private static TaskWriter WriteConfiguratorTask(this TaskWriter writer)
             : $"new {task.Tool.GetClassName()}().Run<{task.SettingsClass.Name}, {task.ReturnType}>(configurator.Invoke(new {task.SettingsClass.Name}()))";
 
         return writer
-            .WriteSummary(task)
-            .WriteRemarks(task)
+            .WriteInherit(task)
             .WriteObsoleteAttributeWhenObsolete(task)
             .WriteLine($"public static {signature} => {invocation};");
     }
@@ -144,8 +143,7 @@ private static TaskWriter WriteCombinatorialConfiguratorTask(this TaskWriter wri
         var invocation = $"configurator.Invoke({task.GetTaskMethodName()}, degreeOfParallelism, completeOnFailure)";
 
         return writer
-            .WriteSummary(task)
-            .WriteRemarks(task)
+            .WriteInherit(task)
             .WriteObsoleteAttributeWhenObsolete(task)
             .WriteLine($"public static {signature} => {invocation};");
     }

diff --git a/source/Nuke.Tooling.Generator/Generators/WriterExtensions.cs b/source/Nuke.Tooling.Generator/Generators/WriterExtensions.cs
@@ -56,6 +56,12 @@ public static T WriteRemarks<T>(this T writerWrapper, Task task)
             .WriteLine($"/// <remarks>{lines.Join(string.Empty)}</remarks>");
     }
 
+    public static T WriteInherit<T>(this T writerWrapper, Task task)
+        where T : IWriterWrapper
+    {
+        return writerWrapper.WriteLine($"/// <inheritdoc cref=\"{task.Tool.GetClassName()}.{task.GetTaskMethodName()}({task.Tool.Namespace}.{task.SettingsClass.Name})\"/>");
+    }
+
     private static IEnumerable<string> GetArgumentsList(DataClass dataClass)
     {
         var allDataClasses = dataClass.Tool.Tasks.Select(x => x.SettingsClass).Concat(dataClass.Tool.DataClasses).ToList();
@@ -91,7 +97,9 @@ string GetArgument(Property property)
     public static T WriteSummary<T>(this T writerWrapper, DataClass dataClass)
         where T : IWriterWrapper
     {
-        return writerWrapper.WriteSummary(GetUsedWithinText(dataClass.Tool));
+        return writerWrapper
+            .When(dataClass is SettingsClass, x => x.WriteInherit(((SettingsClass)dataClass).Task))
+            .When(dataClass is not SettingsClass, x => x.WriteSummary(GetUsedWithinText(dataClass.Tool)));
     }
 
     public static T WriteSummary<T>(this T writerWrapper, Enumeration enumeration)