From cb78da25a45496255b762638fbad26480348138a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20St=C3=BChmer?= Date: Fri, 10 Jan 2025 21:24:01 +0100 Subject: [PATCH] fix: removed todo comments (#136) * fix: removed todo comments * style: Reformatted * fix: removed todo comments * fix: removed further todo comments --- src/NetEvolve.ArchiDuct/Internals/Decompiler.cs | 10 ++++------ .../Models/Abstractions/ModelBase.cs | 2 -- src/NetEvolve.ArchiDuct/Models/ModelAttribute.cs | 5 +---- .../Internals/Decompiler_ExampleFileModifier_Tests.cs | 2 +- .../Internals/Decompiler_SystemUri_Tests.cs | 2 +- .../_internals/AssembliesTestCaseBase.cs | 4 ++-- 6 files changed, 9 insertions(+), 16 deletions(-) diff --git a/src/NetEvolve.ArchiDuct/Internals/Decompiler.cs b/src/NetEvolve.ArchiDuct/Internals/Decompiler.cs index 75c3e53e..cb37b8ae 100644 --- a/src/NetEvolve.ArchiDuct/Internals/Decompiler.cs +++ b/src/NetEvolve.ArchiDuct/Internals/Decompiler.cs @@ -66,8 +66,6 @@ private ModelAssembly DecompileModule(IModule module, HashSet filt MapTypeModels(modelAssembly, module, filters); SetReferences(modelAssembly); - // TODO: Add GitVersion informations - return modelAssembly; } @@ -162,7 +160,7 @@ private void MapMemberModel(ModelAssembly modelAssembly, IMember member, ModelTy if (!ModelFactory.TryGetDocumentation(member, _resolver, out var doc)) { - //TODO: Include undocumented items? + //Include undocumented items? } if ( @@ -176,8 +174,8 @@ parent is ModelEnum var modelMember = ModelFactory.CreateModelMemberType(member, parent, doc, _resolver); MapModelMemberParameters(modelMember, member); - //TODO: Map TypeParameters for methods and indexers - //TODO: ReturnAttributes + //Map TypeParameters for methods and indexers + //ReturnAttributes _ = modelAssembly.Members.Add(modelMember); _ = parent.Members.Add(modelMember.Id); @@ -213,7 +211,7 @@ private void MapTypeModel( if (ModelFactory.TryGetDocumentation(typeDefinition, _resolver, out var doc)) { - //TODO: Include undocumented items? + //Include undocumented items? } if (parent is null) diff --git a/src/NetEvolve.ArchiDuct/Models/Abstractions/ModelBase.cs b/src/NetEvolve.ArchiDuct/Models/Abstractions/ModelBase.cs index ee5e16f2..888b5738 100644 --- a/src/NetEvolve.ArchiDuct/Models/Abstractions/ModelBase.cs +++ b/src/NetEvolve.ArchiDuct/Models/Abstractions/ModelBase.cs @@ -8,8 +8,6 @@ /// public abstract class ModelBase { - // TODO: Add DisplayValue - /// /// Gets the xml for the described object. /// diff --git a/src/NetEvolve.ArchiDuct/Models/ModelAttribute.cs b/src/NetEvolve.ArchiDuct/Models/ModelAttribute.cs index 9c49a261..5c35a95d 100644 --- a/src/NetEvolve.ArchiDuct/Models/ModelAttribute.cs +++ b/src/NetEvolve.ArchiDuct/Models/ModelAttribute.cs @@ -22,8 +22,5 @@ public sealed class ModelAttribute : ModelBase #pragma warning disable IDE0060, RCS1163 // Remove unused parameter internal ModelAttribute(IAttribute attribute, ITypeDefinition typeDefinition, XElement? doc) #pragma warning restore IDE0060, RCS1163 // Remove unused parameter - : base(typeDefinition.GetIdString(), typeDefinition.Name, typeDefinition.FullName, doc) - { - // TODO: Map constructor with values - } + : base(typeDefinition.GetIdString(), typeDefinition.Name, typeDefinition.FullName, doc) { } } diff --git a/tests/NetEvolve.ArchiDuct.Tests.Integration/Internals/Decompiler_ExampleFileModifier_Tests.cs b/tests/NetEvolve.ArchiDuct.Tests.Integration/Internals/Decompiler_ExampleFileModifier_Tests.cs index fa4e1fe2..e12ce6d1 100644 --- a/tests/NetEvolve.ArchiDuct.Tests.Integration/Internals/Decompiler_ExampleFileModifier_Tests.cs +++ b/tests/NetEvolve.ArchiDuct.Tests.Integration/Internals/Decompiler_ExampleFileModifier_Tests.cs @@ -6,7 +6,7 @@ public class Decompiler_ExampleFileModifier_Tests(FileModifierTypeProvider provider) : TestCaseBase( provider, - // TODO: This is a workaround for the issue that CI pipeline, which is running on Linux, is failing the test. + // This is a workaround for the issue that CI pipeline, which is running on Linux, is failing the test. disableMembersCheck: !RuntimeInformation.IsOSPlatform(OSPlatform.Windows), disableTypesCheck: !RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ) { } diff --git a/tests/NetEvolve.ArchiDuct.Tests.Integration/Internals/Decompiler_SystemUri_Tests.cs b/tests/NetEvolve.ArchiDuct.Tests.Integration/Internals/Decompiler_SystemUri_Tests.cs index ad0bb803..d201eb34 100644 --- a/tests/NetEvolve.ArchiDuct.Tests.Integration/Internals/Decompiler_SystemUri_Tests.cs +++ b/tests/NetEvolve.ArchiDuct.Tests.Integration/Internals/Decompiler_SystemUri_Tests.cs @@ -6,7 +6,7 @@ public class Decompiler_SystemUri_Tests(GenericTypeProvider provider) : TypesTestCaseGenericBase( provider, - // TODO: This is a workaround for the issue that CI pipeline, which is running on Linux, is failing the test. + // This is a workaround for the issue that CI pipeline, which is running on Linux, is failing the test. disableMembersCheck: !RuntimeInformation.IsOSPlatform(OSPlatform.Windows), disableTypesCheck: !RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ) { } diff --git a/tests/NetEvolve.ArchiDuct.Tests.Integration/_internals/AssembliesTestCaseBase.cs b/tests/NetEvolve.ArchiDuct.Tests.Integration/_internals/AssembliesTestCaseBase.cs index e6d15370..ed1f7285 100644 --- a/tests/NetEvolve.ArchiDuct.Tests.Integration/_internals/AssembliesTestCaseBase.cs +++ b/tests/NetEvolve.ArchiDuct.Tests.Integration/_internals/AssembliesTestCaseBase.cs @@ -11,7 +11,7 @@ public abstract class AssembliesTestCaseBase(GenericTypeProvider