feat: Implement core configuration classes and attributes for documentation generation

christopherosthues · christopherosthues · commit bc8bf0f9978d · 2025-12-06T22:31:54.000+01:00
diff --git a/DotAutoDocConfig.Core/ComponentModel/Attributes/DocumentationAttribute.cs b/DotAutoDocConfig.Core/ComponentModel/Attributes/DocumentationAttribute.cs
@@ -0,0 +1,9 @@
+using System;
+
+namespace DotAutoDocConfig.Core.ComponentModel.Attributes;
+
+[AttributeUsage(AttributeTargets.Class, Inherited = true, AllowMultiple = false)]
+public class DocumentationAttribute(DocumentationFormat format) : Attribute
+{
+    public DocumentationFormat Format { get; } = format;
+}
diff --git a/DotAutoDocConfig.Core/ComponentModel/Attributes/ExcludeFromDocumentationAttribute.cs b/DotAutoDocConfig.Core/ComponentModel/Attributes/ExcludeFromDocumentationAttribute.cs
@@ -0,0 +1,9 @@
+using System;
+
+namespace DotAutoDocConfig.Core.ComponentModel.Attributes;
+
+[AttributeUsage(AttributeTargets.Class | AttributeTargets.Field | AttributeTargets.Property, Inherited = true, AllowMultiple = false)]
+public class ExcludeFromDocumentationAttribute(string? reason = null) : Attribute
+{
+    public string? Reason { get; } = reason;
+}
diff --git a/DotAutoDocConfig.Core/ComponentModel/DocumentationFormat.cs b/DotAutoDocConfig.Core/ComponentModel/DocumentationFormat.cs
@@ -0,0 +1,12 @@
+using System;
+
+namespace DotAutoDocConfig.Core.ComponentModel;
+
+[Flags]
+public enum DocumentationFormat : byte
+{
+    None = 0,
+    AsciiDoc = 1 << 0,
+    Markdown = 1 << 1,
+    Html = 1 << 2
+}
diff --git a/DotAutoDocConfig.Core/DotAutoDocConfig.Core.csproj b/DotAutoDocConfig.Core/DotAutoDocConfig.Core.csproj
@@ -0,0 +1,8 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFramework>netstandard2.0</TargetFramework>
+        <LangVersion>latest</LangVersion>
+    </PropertyGroup>
+
+</Project>
diff --git a/DotAutoDocConfig.Sample.Console/AppConfiguration.cs b/DotAutoDocConfig.Sample.Console/AppConfiguration.cs
@@ -0,0 +1,38 @@
+using DotAutoDocConfig.Core.ComponentModel;
+using DotAutoDocConfig.Core.ComponentModel.Attributes;
+
+namespace DotAutoDocConfig.Sample.Console;
+
+/// <summary>
+///
+/// </summary>
+[Documentation(DocumentationFormat.Markdown | DocumentationFormat.AsciiDoc)]
+public class AppConfiguration
+{
+    public int MaxItems { get; set; } = 100;
+
+    public string ApplicationName { get; set; } = "DotAutoDocConfig Sample App";
+
+    public bool EnableLogging { get; set; } = true;
+
+    public double TimeoutInSeconds { get; set; } = 30.0;
+
+    public string[] SupportedLanguages { get; set; } = ["en", "es", "fr"];
+
+    public DatabaseConfiguration Database { get; set; } = new();
+
+    [ExcludeFromDocumentation("This property is for internal use only.")]
+    public int RetryAttempts { get; set; } = 3;
+}
+
+public class DatabaseConfiguration
+{
+    public string ConnectionString { get; set; } = "Server=localhost;Database=mydb;User Id=myuser;Password=mypassword;";
+
+    public int MaxConnections { get; set; } = 10;
+
+    [ExcludeFromDocumentation("This property is for internal use only.")]
+    public bool UseSsl { get; set; } = false;
+
+    public int CommandTimeout { get; set; } = 60;
+}
diff --git a/DotAutoDocConfig.Sample.Console/DotAutoDocConfig.Sample.Console.csproj b/DotAutoDocConfig.Sample.Console/DotAutoDocConfig.Sample.Console.csproj
@@ -0,0 +1,14 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net10.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <ProjectReference Include="..\DotAutoDocConfig\DotAutoDocConfig.csproj" />
+    </ItemGroup>
+
+</Project>
diff --git a/DotAutoDocConfig.Sample.Console/Program.cs b/DotAutoDocConfig.Sample.Console/Program.cs
@@ -0,0 +1,3 @@
+﻿// See https://aka.ms/new-console-template for more information
+
+Console.WriteLine("Hello, World!");
diff --git a/DotAutoDocConfig.Sample.Console/appsettings.json b/DotAutoDocConfig.Sample.Console/appsettings.json
@@ -0,0 +1,9 @@
+{
+    "Logging": {
+        "LogLevel": {
+            "Default": "Debug",
+            "System": "Information",
+            "Microsoft": "Information"
+        }
+    }
+}
diff --git a/DotAutoDocConfig.SourceGenerator.Sample/DDD.UbiquitousLanguageRegistry.txt b/DotAutoDocConfig.SourceGenerator.Sample/DDD.UbiquitousLanguageRegistry.txt
diff --git a/DotAutoDocConfig.SourceGenerator.Sample/DotAutoDocConfig.SourceGenerator.Sample.csproj b/DotAutoDocConfig.SourceGenerator.Sample/DotAutoDocConfig.SourceGenerator.Sample.csproj
@@ -6,8 +6,4 @@
   <ItemGroup>
     <ProjectReference Include="..\DotAutoDocConfig.SourceGenerator\DotAutoDocConfig.SourceGenerator.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
   </ItemGroup>
-  <ItemGroup>
-    <None Remove="DDD.UbiquitousLanguageRegistry.txt" />
-    <AdditionalFiles Include="DDD.UbiquitousLanguageRegistry.txt" />
-  </ItemGroup>
 </Project>
diff --git a/DotAutoDocConfig.SourceGenerator.Sample/Examples.cs b/DotAutoDocConfig.SourceGenerator.Sample/Examples.cs
@@ -1,28 +1,14 @@
 using System.Collections.Generic;
-using Entities;
 
 namespace DotAutoDocConfig.SourceGenerator.Sample;
 
 // This code will not compile until you build the project with the Source Generators
 
 public class Examples
 {
-    // Create generated entities, based on DDD.UbiquitousLanguageRegistry.txt
-    public object[] CreateEntities()
-    {
-        return new object[]
-        {
-            new Customer(),
-            new Employee(),
-            new Product(),
-            new Shop(),
-            new Stock()
-        };
-    }
-
     // Execute generated method Report
     public IEnumerable<string> CreateEntityReport(SampleEntity entity)
     {
         return entity.Report();
     }
-}
+}
diff --git a/DotAutoDocConfig.SourceGenerator.Tests/SourceGeneratorWithAdditionalFilesTests.cs b/DotAutoDocConfig.SourceGenerator.Tests/SourceGeneratorWithAdditionalFilesTests.cs
diff --git a/DotAutoDocConfig.SourceGenerator.Tests/SourceGeneratorWithAttributesTests.cs b/DotAutoDocConfig.SourceGenerator.Tests/SourceGeneratorWithAttributesTests.cs
@@ -46,7 +46,7 @@ public async Task GenerateReportMethod()
         CSharpGeneratorDriver driver = CSharpGeneratorDriver.Create(generator);
 
         // We need to create a compilation with the required source code.
-        CSharpCompilation compilation = CSharpCompilation.Create(nameof(SourceGeneratorWithAdditionalFilesTests),
+        CSharpCompilation compilation = CSharpCompilation.Create(nameof(SourceGeneratorWithAttributesTests),
             [CSharpSyntaxTree.ParseText(VectorClassText)],
             [
                 // To support 'System.Attribute' inheritance, add reference to 'System.Private.CoreLib'.
diff --git a/DotAutoDocConfig.SourceGenerator/ConfigurationDocAttribute.cs b/DotAutoDocConfig.SourceGenerator/ConfigurationDocAttribute.cs
diff --git a/DotAutoDocConfig.SourceGenerator/DotAutoDocConfig.SourceGenerator.csproj b/DotAutoDocConfig.SourceGenerator/DotAutoDocConfig.SourceGenerator.csproj
@@ -15,4 +15,7 @@
     </PackageReference>
     <PackageReference Include="Microsoft.CodeAnalysis.CSharp" />
   </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\DotAutoDocConfig.Core\DotAutoDocConfig.Core.csproj" />
+  </ItemGroup>
 </Project>
diff --git a/DotAutoDocConfig.SourceGenerator/SourceGeneratorWithAdditionalFiles.cs b/DotAutoDocConfig.SourceGenerator/SourceGeneratorWithAdditionalFiles.cs
diff --git a/DotAutoDocConfig.SourceGenerator/SourceGeneratorWithAttributes.cs b/DotAutoDocConfig.SourceGenerator/SourceGeneratorWithAttributes.cs
@@ -17,7 +17,7 @@ namespace DotAutoDocConfig.SourceGenerator;
 public class SourceGeneratorWithAttributes : IIncrementalGenerator
 {
     private const string Namespace = "Generators";
-    private const string AttributeName = "ConfigurationDocAttribute";
+    private const string AttributeName = "ReportAttribute";
 
     private const string AttributeSourceCode = $@"// <auto-generated/>
 
diff --git a/DotAutoDocConfig.slnx b/DotAutoDocConfig.slnx
@@ -5,11 +5,20 @@
     <File Path="Directory.Build.targets" />
     <File Path="Directory.Packages.props" />
   </Folder>
+  <Folder Name="/DotAutoDocConfig/">
+    <Project Path="DotAutoDocConfig.Core/DotAutoDocConfig.Core.csproj" />
+    <Project Path="DotAutoDocConfig.SourceGenerator/DotAutoDocConfig.SourceGenerator.csproj" />
+    <Project Path="DotAutoDocConfig/DotAutoDocConfig.csproj" />
+  </Folder>
   <Folder Name="/Pipeline/">
     <File Path=".github/dependabot.yml" />
     <File Path=".github/workflows/dotnet.yml" />
   </Folder>
-  <Project Path="DotAutoDocConfig.SourceGenerator.Sample/DotAutoDocConfig.SourceGenerator.Sample.csproj" />
-  <Project Path="DotAutoDocConfig.SourceGenerator.Tests/DotAutoDocConfig.SourceGenerator.Tests.csproj" />
-  <Project Path="DotAutoDocConfig.SourceGenerator/DotAutoDocConfig.SourceGenerator.csproj" />
+  <Folder Name="/Samples/">
+    <Project Path="DotAutoDocConfig.Sample.Console/DotAutoDocConfig.Sample.Console.csproj" />
+    <Project Path="DotAutoDocConfig.SourceGenerator.Sample/DotAutoDocConfig.SourceGenerator.Sample.csproj" />
+  </Folder>
+  <Folder Name="/Tests/">
+    <Project Path="DotAutoDocConfig.SourceGenerator.Tests/DotAutoDocConfig.SourceGenerator.Tests.csproj" />
+  </Folder>
 </Solution>
diff --git a/DotAutoDocConfig/DotAutoDocConfig.csproj b/DotAutoDocConfig/DotAutoDocConfig.csproj
@@ -0,0 +1,13 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFrameworks>netstandard2.0;netstandard2.1;net8.0;net9.0;net10.0</TargetFrameworks>
+        <LangVersion>latest</LangVersion>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\DotAutoDocConfig.Core\DotAutoDocConfig.Core.csproj" />
+      <ProjectReference Include="..\DotAutoDocConfig.SourceGenerator\DotAutoDocConfig.SourceGenerator.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
+    </ItemGroup>
+
+</Project>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+// See https://aka.ms/new-console-template for more information`
	`2`	`+`
	`3`	`+Console.WriteLine("Hello, World!");`