DefaultDocumentation.Markdown is now its own nuget package (closes #98)

Doraku · Jun 14, 2022 · 84a2aee · 84a2aee
1 parent d0397ef
commit 84a2aee
Show file tree

Hide file tree

Showing 242 changed files with 5,188 additions and 8 deletions.
diff --git a/.github/workflows/Release.yml b/.github/workflows/Release.yml
@@ -51,7 +51,9 @@ jobs:
       run: echo "" | Out-File documentation\NEXT_RELEASENOTES.txt -NoNewLine
 
     - name: Generate documentation
-      run: dotnet run --project source\DefaultDocumentation.Console\DefaultDocumentation.Console.csproj --framework net6.0 -c Release --ConfigurationFilePath source\DefaultDocumentation.Api\DefaultDocumentation.json
+      run: |
+        dotnet run --project source\DefaultDocumentation.Console\DefaultDocumentation.Console.csproj --framework net6.0 -c Release --ConfigurationFilePath source\DefaultDocumentation.Api\DefaultDocumentation.json
+        dotnet run --project source\DefaultDocumentation.Console\DefaultDocumentation.Console.csproj --framework net6.0 -c Release --ConfigurationFilePath source\DefaultDocumentation.Markdown\DefaultDocumentation.json
       
     - name: Publish packages
       run: dotnet nuget push build\*.nupkg --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json

diff --git a/Release.bat b/Release.bat
@@ -5,4 +5,5 @@ dotnet clean source\DefaultDocumentation.sln -c Release
 
 dotnet pack source\DefaultDocumentation.sln -c Release -o build /p:LOCAL_VERSION=true
 
-dotnet run --project source\DefaultDocumentation.Console\DefaultDocumentation.Console.csproj --framework net6.0 -c Release --ConfigurationFilePath source\DefaultDocumentation.Api\DefaultDocumentation.json
+dotnet run --project source\DefaultDocumentation.Console\DefaultDocumentation.Console.csproj --framework net6.0 -c Release --ConfigurationFilePath source\DefaultDocumentation.Api\DefaultDocumentation.json
+dotnet run --project source\DefaultDocumentation.Console\DefaultDocumentation.Console.csproj --framework net6.0 -c Release --ConfigurationFilePath source\DefaultDocumentation.Markdown\DefaultDocumentation.json
diff --git a/documentation/DefaultDocumentation.Markdown.txt b/documentation/DefaultDocumentation.Markdown.txt
diff --git a/documentation/api/IUrlFactory.GetUrl(IGeneralContext,string).md b/documentation/api/IUrlFactory.GetUrl(IGeneralContext,string).md
@@ -3,7 +3,7 @@
 
 ## IUrlFactory.GetUrl(IGeneralContext, string) Method
 
-Gets thr url of the given id.
+Gets the url of the given id. Returns null of the instance does not know how to handle the provided id.
 
 ```csharp
 string? GetUrl(DefaultDocumentation.IGeneralContext context, string id);

diff --git a/documentation/api/IUrlFactory.md b/documentation/api/IUrlFactory.md
@@ -3,7 +3,7 @@
 
 ## IUrlFactory Interface
 
-Exposes methods related to the documentation files cleaning and creation.
+Exposes methods related to the documentation files url creation.
 
 ```csharp
 public interface IUrlFactory
@@ -15,4 +15,4 @@ public interface IUrlFactory
 
 | Methods | |
 | :--- | :--- |
-| [GetUrl(IGeneralContext, string)](IUrlFactory.GetUrl(IGeneralContext,string).md 'DefaultDocumentation.Api.IUrlFactory.GetUrl(DefaultDocumentation.IGeneralContext, string)') | Gets thr url of the given id. |
+| [GetUrl(IGeneralContext, string)](IUrlFactory.GetUrl(IGeneralContext,string).md 'DefaultDocumentation.Api.IUrlFactory.GetUrl(DefaultDocumentation.IGeneralContext, string)') | Gets the url of the given id. Returns null of the instance does not know how to handle the provided id. |
diff --git a/documentation/api/index.md b/documentation/api/index.md
@@ -84,9 +84,9 @@ The [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumen
 - **[ISection](ISection.md 'DefaultDocumentation.Api.ISection')** `Interface` Exposes a method to write a specific section when writing documentation.
   - **[Name](ISection.Name.md 'DefaultDocumentation.Api.ISection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level.
   - **[Write(IWriter)](ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter').
-- **[IUrlFactory](IUrlFactory.md 'DefaultDocumentation.Api.IUrlFactory')** `Interface` Exposes methods related to the documentation files cleaning and creation.
+- **[IUrlFactory](IUrlFactory.md 'DefaultDocumentation.Api.IUrlFactory')** `Interface` Exposes methods related to the documentation files url creation.
   - **[Name](IUrlFactory.Name.md 'DefaultDocumentation.Api.IUrlFactory.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level.
-  - **[GetUrl(IGeneralContext, string)](IUrlFactory.GetUrl(IGeneralContext,string).md 'DefaultDocumentation.Api.IUrlFactory.GetUrl(DefaultDocumentation.IGeneralContext, string)')** `Method` Gets thr url of the given id.
+  - **[GetUrl(IGeneralContext, string)](IUrlFactory.GetUrl(IGeneralContext,string).md 'DefaultDocumentation.Api.IUrlFactory.GetUrl(DefaultDocumentation.IGeneralContext, string)')** `Method` Gets the url of the given id. Returns null of the instance does not know how to handle the provided id.
 - **[IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter')** `Interface` Exposes properties and methods use to generate a documentation file for a specific [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem').
   - **[Context](IWriter.Context.md 'DefaultDocumentation.Api.IWriter.Context')** `Property` Gets the [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process.
   - **[DocItem](IWriter.DocItem.md 'DefaultDocumentation.Api.IWriter.DocItem')** `Property` Gets the [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') for which the documentation is being generated.

diff --git a/documentation/markdown/AMarkdownFactory.Clean(IGeneralContext).md b/documentation/markdown/AMarkdownFactory.Clean(IGeneralContext).md
@@ -0,0 +1,19 @@
+#### [DefaultDocumentation.Markdown](index.md 'index')
+### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[AMarkdownFactory](AMarkdownFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory')
+
+## AMarkdownFactory.Clean(IGeneralContext) Method
+
+Cleans the [OutputDirectory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISettings.OutputDirectory.md 'DefaultDocumentation.ISettings.OutputDirectory') of the previously generated documentation files.
+
+```csharp
+public void Clean(DefaultDocumentation.IGeneralContext context);
+```
+#### Parameters
+
+<a name='DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.Clean(DefaultDocumentation.IGeneralContext).context'></a>
+
+`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext')
+
+The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process.
+
+Implements [Clean(IGeneralContext)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.Clean(IGeneralContext).md 'DefaultDocumentation.Api.IFileNameFactory.Clean(DefaultDocumentation.IGeneralContext)')
diff --git a/documentation/markdown/AMarkdownFactory.GetFileName(IGeneralContext,DocItem).md b/documentation/markdown/AMarkdownFactory.GetFileName(IGeneralContext,DocItem).md
@@ -0,0 +1,29 @@
+#### [DefaultDocumentation.Markdown](index.md 'index')
+### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[AMarkdownFactory](AMarkdownFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory')
+
+## AMarkdownFactory.GetFileName(IGeneralContext, DocItem) Method
+
+Gets the documentation file name for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem').
+
+```csharp
+public string GetFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item);
+```
+#### Parameters
+
+<a name='DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.GetFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem).context'></a>
+
+`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext')
+
+The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process.
+
+<a name='DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.GetFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem).item'></a>
+
+`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem')
+
+The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which to get the documentation file name.
+
+Implements [GetFileName(IGeneralContext, DocItem)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.GetFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Api.IFileNameFactory.GetFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)')
+
+#### Returns
+[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')  
+The documentation file name of the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem').
diff --git a/...ation/markdown/AMarkdownFactory.GetMarkdownFileName(IGeneralContext,DocItem).md b/...ation/markdown/AMarkdownFactory.GetMarkdownFileName(IGeneralContext,DocItem).md
@@ -0,0 +1,27 @@
+#### [DefaultDocumentation.Markdown](index.md 'index')
+### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[AMarkdownFactory](AMarkdownFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory')
+
+## AMarkdownFactory.GetMarkdownFileName(IGeneralContext, DocItem) Method
+
+Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem').
+
+```csharp
+protected abstract string GetMarkdownFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item);
+```
+#### Parameters
+
+<a name='DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem).context'></a>
+
+`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext')
+
+The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process.
+
+<a name='DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem).item'></a>
+
+`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem')
+
+The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which to get the documentation file name.
+
+#### Returns
+[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')  
+The file name to use.
diff --git a/documentation/markdown/AMarkdownFactory.Name.md b/documentation/markdown/AMarkdownFactory.Name.md
@@ -0,0 +1,15 @@
+#### [DefaultDocumentation.Markdown](index.md 'index')
+### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[AMarkdownFactory](AMarkdownFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory')
+
+## AMarkdownFactory.Name Property
+
+Gets the name of the factory, used to identify it at the configuration level.
+
+```csharp
+public abstract string Name { get; }
+```
+
+Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.Name.md 'DefaultDocumentation.Api.IFileNameFactory.Name')
+
+#### Property Value
+[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
diff --git a/documentation/markdown/AMarkdownFactory.md b/documentation/markdown/AMarkdownFactory.md
@@ -0,0 +1,32 @@
+#### [DefaultDocumentation.Markdown](index.md 'index')
+### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories')
+
+## AMarkdownFactory Class
+
+Base implementation of the [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') to generate file with a `.md` extension.  
+It will also replace invalid char that may be present with the [Markdown.InvalidCharReplacement](https://github.com/Doraku/DefaultDocumentation#invalidcharreplacement 'https://github.com/Doraku/DefaultDocumentation#invalidcharreplacement') setting.
+
+```csharp
+public abstract class AMarkdownFactory :
+DefaultDocumentation.Api.IFileNameFactory
+```
+
+Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; AMarkdownFactory
+
+Derived  
+&#8627; [FullNameFactory](FullNameFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory')  
+&#8627; [Md5Factory](Md5Factory.md 'DefaultDocumentation.Markdown.FileNameFactories.Md5Factory')  
+&#8627; [NameAndMd5MixFactory](NameAndMd5MixFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory')  
+&#8627; [NameFactory](NameFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.NameFactory')
+
+Implements [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory')
+
+| Properties | |
+| :--- | :--- |
+| [Name](AMarkdownFactory.Name.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.Name') | Gets the name of the factory, used to identify it at the configuration level. |
+
+| Methods | |
+| :--- | :--- |
+| [Clean(IGeneralContext)](AMarkdownFactory.Clean(IGeneralContext).md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.Clean(DefaultDocumentation.IGeneralContext)') | Cleans the [OutputDirectory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISettings.OutputDirectory.md 'DefaultDocumentation.ISettings.OutputDirectory') of the previously generated documentation files. |
+| [GetFileName(IGeneralContext, DocItem)](AMarkdownFactory.GetFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.GetFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)') | Gets the documentation file name for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). |
+| [GetMarkdownFileName(IGeneralContext, DocItem)](AMarkdownFactory.GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)') | Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). |
diff --git a/documentation/markdown/CElement.Name.md b/documentation/markdown/CElement.Name.md
@@ -0,0 +1,15 @@
+#### [DefaultDocumentation.Markdown](index.md 'index')
+### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[CElement](CElement.md 'DefaultDocumentation.Markdown.Elements.CElement')
+
+## CElement.Name Property
+
+Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle.
+
+```csharp
+public string Name { get; }
+```
+
+Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Name.md 'DefaultDocumentation.Api.IElement.Name')
+
+#### Property Value
+[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
diff --git a/documentation/markdown/CElement.Write(IWriter,XElement).md b/documentation/markdown/CElement.Write(IWriter,XElement).md
@@ -0,0 +1,25 @@
+#### [DefaultDocumentation.Markdown](index.md 'index')
+### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[CElement](CElement.md 'DefaultDocumentation.Markdown.Elements.CElement')
+
+## CElement.Write(IWriter, XElement) Method
+
+Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement').
+
+```csharp
+public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element);
+```
+#### Parameters
+
+<a name='DefaultDocumentation.Markdown.Elements.CElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement).writer'></a>
+
+`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter')
+
+The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to.
+
+<a name='DefaultDocumentation.Markdown.Elements.CElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement).element'></a>
+
+`element` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement')
+
+The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') to write.
+
+Implements [Write(IWriter, XElement)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Write(IWriter,XElement).md 'DefaultDocumentation.Api.IElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)')
diff --git a/documentation/markdown/CElement.md b/documentation/markdown/CElement.md
@@ -0,0 +1,23 @@
+#### [DefaultDocumentation.Markdown](index.md 'index')
+### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements')
+
+## CElement Class
+
+Handles `c` xml element.
+
+```csharp
+public sealed class CElement :
+DefaultDocumentation.Api.IElement
+```
+
+Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; CElement
+
+Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.md 'DefaultDocumentation.Api.IElement')
+
+| Properties | |
+| :--- | :--- |
+| [Name](CElement.Name.md 'DefaultDocumentation.Markdown.Elements.CElement.Name') | Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. |
+
+| Methods | |
+| :--- | :--- |
+| [Write(IWriter, XElement)](CElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.CElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). |