#27: Added ApiDescription class for generating library Public Api in …

…form of markdown

Documentation/Synergy.Documentation.Tests/Architecture/Debt/Todos.Technical.Debt.verified.md

@@ -0,0 +1,18 @@
+# Technical Debt for Synergy.Contracts
+
+Total: 5
+
+## [ApiDescription.cs](../../../Synergy.Documentation/Api/ApiDescription.cs)
+- TODO: Marcin Celej [from: Marcin Celej on: 08-04-2023]: Duplicated class
+
+## [CodeFile.cs](../../../Synergy.Documentation/Code/CodeFile.cs)
+- TODO: Marcin Celej [from: Marcin Celej on: 14-05-2023]: rename to SourceFile
+
+## [CodeFolder.cs](../../../Synergy.Documentation/Code/CodeFolder.cs)
+- TODO: Marcin Celej [from: Marcin Celej on: 14-05-2023]: Rename to SourceFolder
+
+## [TodoPattern.cs](../../../Synergy.Documentation/Todos/Patterns/TodoPattern.cs)
+- TODO: Marcin Celej [from: Marcin Celej on: 14-04-2023]: Add way to exclude some files from the scan - by path
+
+## [TodoExplorer.cs](../../../Synergy.Documentation/Todos/TodoExplorer.cs)
+- TODO: Marcin Celej [from: Marcin Celej on: 30-04-2023]: Publish this library via nuget

Documentation/Synergy.Documentation.Tests/Todos/Todos.cs → Documentation/Synergy.Documentation.Tests/Architecture/Debt/Todos.cs

@@ -1,7 +1,7 @@
 using Synergy.Documentation.Code;
 using Synergy.Documentation.Todos;
 
-namespace Synergy.Documentation.Tests.Todos;
+namespace Synergy.Documentation.Tests.Architecture;
 
 [UsesVerify]
 public class Todos
@@ -10,7 +10,7 @@ public class Todos
     public async Task Generate()
     {
         var rootFolder = CodeFolder.Current()
-                                   .Up(2);
+                                   .Up(3);
         var technicalDebt = TodoExplorer.DebtFor("Synergy.Contracts", rootFolder);
 
         await Verifier

Documentation/Synergy.Documentation.Tests/Architecture/Public/Api.cs

@@ -0,0 +1,22 @@
+using Synergy.Documentation.Api;
+
+namespace Synergy.Documentation.Tests.Architecture.Public;
+
+[UsesVerify]
+public class Api
+{
+    [Fact]
+    public async Task Generate()
+    {
+        // ARRANGE
+        var assembly = typeof(ApiDescription).Assembly;
+
+        // ACT
+        var publicApi = ApiDescription.GenerateFor(assembly);
+
+        // ASSERT
+        await Verifier.Verify(publicApi, "md")
+                      .UseMethodName("of." + assembly.GetName()
+                                                      .Name);
+    }
+}

Documentation/Synergy.Documentation.Tests/Architecture/Public/Api.of.Synergy.Documentation.verified.md

@@ -0,0 +1,109 @@
+# Synergy.Documentation
+
+## Todos.TodoExplorer (abstract class)
+ - TodoExplorer.DebtFor(
+     name: string,
+     from: CodeFolder,
+     currentPath: string [CallerFilePath, Optional],
+     patterns: params TodoPattern[] [ParamArray]
+   ) : string
+
+## Todos.Patterns.CsharpTodoPattern (record) : TodoPattern, IEquatable<TodoPattern>, IEquatable<CsharpTodoPattern>
+ - FileExtension: string { get; set; }
+ - Regex: Regex { get; set; }
+ - TodoExtractor: Func<Match, string> { get; set; }
+ - ctor()
+
+## Todos.Patterns.GherkinTodoPattern (record) : TodoPattern, IEquatable<TodoPattern>, IEquatable<GherkinTodoPattern>
+ - FileExtension: string { get; set; }
+ - Regex: Regex { get; set; }
+ - TodoExtractor: Func<Match, string> { get; set; }
+ - ctor()
+
+## Todos.Patterns.TextTodoPattern (record) : TodoPattern, IEquatable<TodoPattern>, IEquatable<TextTodoPattern>
+ - FileExtension: string { get; set; }
+ - Regex: Regex { get; set; }
+ - TodoExtractor: Func<Match, string> { get; set; }
+ - ctor()
+
+## Todos.Patterns.TodoPattern (abstract class) : IEquatable<TodoPattern>
+ - FileExtension: string { get; set; }
+ - Regex: Regex { get; set; }
+ - TodoExtractor: Func<Match, string> { get; set; }
+
+## Code.ClassReader (class)
+ - ctor()
+ - ClassReader.ReadMethodBody(
+     methodName: string,
+     sourceFilePath: string [CallerFilePath, Optional]
+   ) : string? [NullableContext]
+
+## Code.CodeFile (class)
+ - Extension: string { get; }
+ - FileName: string { get; }
+ - FileNameWithoutExtension: string { get; }
+ - FilePath: string { get; }
+ - Folder: CodeFolder { get; }
+ - ctor(
+     filePath: string
+   )
+ - CodeFile.Current(
+     path: string [CallerFilePath, Optional]
+   ) : CodeFolder
+ - RelativeTo(
+     folder: CodeFolder
+   ) : CodeFile
+ - ToString() : string
+
+## Code.CodeFolder (class)
+ - Path: string { get; }
+ - ctor(
+     path: string
+   )
+ - CodeFolder.Current(
+     path: string [CallerFilePath, Optional]
+   ) : CodeFolder
+ - File(
+     fileName: string
+   ) : CodeFile
+ - ToString() : string
+ - Up(
+     jumps: int [Optional]
+   ) : CodeFolder
+
+## Api.ApiDescription (abstract class)
+ - ApiDescription.For(
+     method: MethodInfo,
+     withAttributes: bool [Optional]
+   ) : string
+ - ApiDescription.GenerateFor(
+     assembly: Assembly
+   ) : string
+ - ApiDescription.GenerateFor(
+     types: IEnumerable<Type>,
+     description: StringBuilder? [Nullable, Optional],
+     assemblyName: string? [Nullable, Optional]
+   ) : string
+ - ApiDescription.GetTypeName(
+     method: MethodInfo
+   ) : string
+ - ApiDescription.GetTypeName(
+     parameter: ParameterInfo
+   ) : string
+ - ApiDescription.GetTypeName(
+     type: Type
+   ) : string
+
+## Api.ClassDocumentation (class) : Markdown+Document, IEnumerable<Markdown+IElement>, IEnumerable
+ - ctor(
+     type: Type
+   )
+ - Append(
+     element: Markdown+IElement
+   ) : Markdown+Document
+ - Append(
+     newElements: IEnumerable<Markdown+IElement>
+   ) : Markdown+Document
+ - GetEnumerator() : IEnumerator<Markdown+IElement>
+ - ToString() : string
+

Documentation/Synergy.Documentation.Tests/Synergy.Documentation.Tests.csproj

@@ -12,6 +12,10 @@
         <ParentFile>Todos</ParentFile>
         <DependentUpon>Todos.cs</DependentUpon>
       </None>
+      <None Update="Architecture\Public\Api.of.Synergy.Behaviours.Testing.verified.md">
+        <ParentFile>Api</ParentFile>
+        <DependentUpon>Api.cs</DependentUpon>
+      </None>
     </ItemGroup>
 
     <ItemGroup>