Skip to content

Commit a0d6eb7

Browse files
darthsharpdarthsharp
authored
Add xml doc generation to Core project (#106)
* Improve XML documentation for CreativeCoders.Core APIs - Add detailed XML summaries, parameters, and return descriptions for public methods, properties, and classes across various extension methods and utilities. - Enhance API usability with clearer comments for reflection, collections, delegates, expressions, and generic utilities. * Refactor: Simplify `Ensure` validation calls by removing `nameof` parameters across the codebase. * Remove outdated C# development guidelines and update `.gitignore` - Deleted `.github/csharp.instructions.md` as the file is no longer relevant. - Added `.tokensave` entry to `.gitignore` for improved repository sanitation.
1 parent 64e9915 commit a0d6eb7

250 files changed

Lines changed: 4753 additions & 897 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/csharp.instructions.md‎

Lines changed: 0 additions & 123 deletions
This file was deleted.

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,3 +330,4 @@ ASALocalRun/
330330
.DS_Store
331331

332332
.ai-plans
333+
.tokensave

‎Core.sln‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33
VisualStudioVersion = 17.0.31903.59
44
MinimumVisualStudioVersion = 10.0.40219.1
55
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Core", "Core", "{D0A3F2FC-664B-4A9D-ACF9-F00EF8E9DFE1}"
6-
ProjectSection(SolutionItems) = preProject
7-
source\Core\README.md = source\Core\README.md
8-
EndProjectSection
96
EndProject
107
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CreativeCoders.Core", "source\Core\CreativeCoders.Core\CreativeCoders.Core.csproj", "{606AB477-7D63-48EB-814C-46DFE03CB6DE}"
118
EndProject

‎Directory.Packages.props‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -11,47 +11,47 @@
1111
<PackageVersion Include="FakeItEasy" Version="9.0.1" />
1212
<PackageVersion Include="JetBrains.Annotations" Version="2025.2.4" />
1313
<PackageVersion Include="LiteDB" Version="5.0.21" />
14-
<PackageVersion Include="log4net" Version="3.3.0" />
15-
<PackageVersion Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="10.0.5" />
16-
<PackageVersion Include="Microsoft.AspNetCore.Components" Version="10.0.5" />
17-
<PackageVersion Include="Microsoft.AspNetCore.Components.Web" Version="10.0.5" />
18-
<PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly" Version="10.0.5" />
19-
<PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly.Authentication" Version="10.0.5" />
20-
<PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly.DevServer" Version="10.0.5" />
14+
<PackageVersion Include="log4net" Version="3.3.1" />
15+
<PackageVersion Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="10.0.7" />
16+
<PackageVersion Include="Microsoft.AspNetCore.Components" Version="10.0.7" />
17+
<PackageVersion Include="Microsoft.AspNetCore.Components.Web" Version="10.0.7" />
18+
<PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly" Version="10.0.7" />
19+
<PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly.Authentication" Version="10.0.7" />
20+
<PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly.DevServer" Version="10.0.7" />
2121
<PackageVersion Include="Microsoft.AspNetCore.Mvc.Core" Version="2.3.9" />
22-
<PackageVersion Include="Microsoft.AspNetCore.TestHost" Version="10.0.5" />
22+
<PackageVersion Include="Microsoft.AspNetCore.TestHost" Version="10.0.7" />
2323
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="5.3.0" />
24-
<PackageVersion Include="Microsoft.EntityFrameworkCore" Version="10.0.5" />
25-
<PackageVersion Include="Microsoft.EntityFrameworkCore.SqlServer" Version="10.0.5" />
26-
<PackageVersion Include="Microsoft.Extensions.Configuration" Version="10.0.5" />
27-
<PackageVersion Include="Microsoft.Extensions.Configuration.Abstractions" Version="10.0.5" />
28-
<PackageVersion Include="Microsoft.Extensions.Configuration.Json" Version="10.0.5" />
29-
<PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="10.0.5" />
30-
<PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="10.0.5" />
31-
<PackageVersion Include="Microsoft.Extensions.Hosting" Version="10.0.5" />
32-
<PackageVersion Include="Microsoft.Extensions.Hosting.Systemd" Version="10.0.5" />
33-
<PackageVersion Include="Microsoft.Extensions.Hosting.WindowsServices" Version="10.0.5" />
34-
<PackageVersion Include="Microsoft.Extensions.Http" Version="10.0.5" />
35-
<PackageVersion Include="Microsoft.Extensions.Http.Polly" Version="10.0.5" />
36-
<PackageVersion Include="Microsoft.Extensions.Localization" Version="10.0.5" />
37-
<PackageVersion Include="Microsoft.Extensions.Logging" Version="10.0.5" />
38-
<PackageVersion Include="Microsoft.Extensions.Options" Version="10.0.5" />
39-
<PackageVersion Include="Microsoft.JSInterop" Version="10.0.5" />
24+
<PackageVersion Include="Microsoft.EntityFrameworkCore" Version="10.0.7" />
25+
<PackageVersion Include="Microsoft.EntityFrameworkCore.SqlServer" Version="10.0.7" />
26+
<PackageVersion Include="Microsoft.Extensions.Configuration" Version="10.0.7" />
27+
<PackageVersion Include="Microsoft.Extensions.Configuration.Abstractions" Version="10.0.7" />
28+
<PackageVersion Include="Microsoft.Extensions.Configuration.Json" Version="10.0.7" />
29+
<PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="10.0.7" />
30+
<PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="10.0.7" />
31+
<PackageVersion Include="Microsoft.Extensions.Hosting" Version="10.0.7" />
32+
<PackageVersion Include="Microsoft.Extensions.Hosting.Systemd" Version="10.0.7" />
33+
<PackageVersion Include="Microsoft.Extensions.Hosting.WindowsServices" Version="10.0.7" />
34+
<PackageVersion Include="Microsoft.Extensions.Http" Version="10.0.7" />
35+
<PackageVersion Include="Microsoft.Extensions.Http.Polly" Version="10.0.7" />
36+
<PackageVersion Include="Microsoft.Extensions.Localization" Version="10.0.7" />
37+
<PackageVersion Include="Microsoft.Extensions.Logging" Version="10.0.7" />
38+
<PackageVersion Include="Microsoft.Extensions.Options" Version="10.0.7" />
39+
<PackageVersion Include="Microsoft.JSInterop" Version="10.0.7" />
4040
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.4.0" />
4141
<PackageVersion Include="MimeMapping" Version="4.0.0" />
4242
<PackageVersion Include="Newtonsoft.Json" Version="13.0.4" />
4343
<PackageVersion Include="NHibernate" Version="5.6.0" />
4444
<PackageVersion Include="Octokit" Version="14.0.0" />
4545
<PackageVersion Include="Polly" Version="8.6.6" />
46-
<PackageVersion Include="Spectre.Console" Version="0.55.0" />
46+
<PackageVersion Include="Spectre.Console" Version="0.55.2" />
4747
<PackageVersion Include="Swashbuckle.AspNetCore" Version="10.1.7" />
4848
<PackageVersion Include="System.IO.Abstractions" Version="22.1.1" />
4949
<PackageVersion Include="System.IO.Abstractions.TestingHelpers" Version="22.1.1" />
50-
<PackageVersion Include="System.IO.Ports" Version="10.0.5" />
50+
<PackageVersion Include="System.IO.Ports" Version="10.0.7" />
5151
<PackageVersion Include="System.Reactive" Version="6.1.0" />
5252
<PackageVersion Include="xunit" Version="2.9.3" />
5353
<PackageVersion Include="xunit.runner.visualstudio" Version="3.1.5" />
5454
<PackageVersion Include="XunitXml.TestLogger" Version="8.0.0" />
5555
<PackageVersion Include="YamlDotNet" Version="17.0.1" />
5656
</ItemGroup>
57-
</Project>
57+
</Project>

‎samples/NetSampleApp/AvmTest.cs‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,5 @@ public static async Task Run()
4242
.ConfigureAwait(false);
4343

4444
hostEntries.ForEach(x => Console.WriteLine($"{x.HostName}: {x.IpAddress}"));
45-
46-
//var device = fritzBox.Wlan.GetWlanDeviceInfo("8C:B8:4A:CA:8F:29");
47-
48-
//Console.WriteLine($"Ip: {device.IpAddress}");
4945
}
5046
}

‎source/AspNetCore/CreativeCoders.AspNetCore/RawRequestBodyFormatter.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public RawRequestBodyFormatter()
1919

2020
public override bool CanRead(InputFormatterContext context)
2121
{
22-
Ensure.IsNotNull(context, nameof(context));
22+
Ensure.IsNotNull(context);
2323

2424
var contentType = context.HttpContext.Request.ContentType;
2525
return string.IsNullOrEmpty(contentType) ||

‎source/CodeCompilation/CreativeCoders.CodeCompilation.Roslyn/RoslynCompilationResult.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ internal class RoslynCompilationResult : ICompilationResult
1616

1717
public RoslynCompilationResult(CSharpCompilation compilation, ICompilationOutputData outputData)
1818
{
19-
Ensure.IsNotNull(compilation, nameof(compilation));
20-
Ensure.IsNotNull(outputData, nameof(outputData));
19+
Ensure.IsNotNull(compilation);
20+
Ensure.IsNotNull(outputData);
2121

2222
_compilation = compilation;
2323
_outputData = outputData;

‎source/CodeCompilation/CreativeCoders.CodeCompilation.Roslyn/RoslynCompiler.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ public class RoslynCompiler : ICompiler
1616
public ICompilationResult Compile(CompilationPackage compilationPackage,
1717
CompilationOutput compilationOutput)
1818
{
19-
Ensure.IsNotNull(compilationOutput, nameof(compilationOutput));
19+
Ensure.IsNotNull(compilationOutput);
2020

2121
var syntaxTrees = CreateSyntaxTrees(compilationPackage.SourceCodes).ToArray();
2222

‎source/CodeCompilation/CreativeCoders.CodeCompilation/CompilationMessage.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ public class CompilationMessage
99
{
1010
public CompilationMessage(CompilationMessageType messageType, TextSpan sourceSpan, string message)
1111
{
12-
Ensure.IsNotNull(messageType, nameof(messageType));
13-
Ensure.IsNotNull(sourceSpan, nameof(sourceSpan));
12+
Ensure.IsNotNull(messageType);
13+
Ensure.IsNotNull(sourceSpan);
1414

1515
MessageType = messageType;
1616
SourceSpan = sourceSpan;

‎source/CodeCompilation/CreativeCoders.CodeCompilation/CompilerFactory.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ public class CompilerFactory : ICompilerFactory
1111

1212
public CompilerFactory(Func<ICompiler> createCompiler)
1313
{
14-
Ensure.IsNotNull(createCompiler, nameof(createCompiler));
14+
Ensure.IsNotNull(createCompiler);
1515

1616
_createCompiler = createCompiler;
1717
}

0 commit comments

Comments
 (0)