added DirectoryName IFileNameFactory implementation (closes #104)

Doraku · Oct 23, 2024 · 5c4a6b4 · 5c4a6b4
1 parent fb67f6b
commit 5c4a6b4
Show file tree

Hide file tree

Showing 821 changed files with 10,360 additions and 8,291 deletions.
diff --git a/README.md b/README.md
@@ -21,6 +21,7 @@ dotnet tool
 [![Coverage Status](https://coveralls.io/repos/github/Doraku/DefaultDocumentation/badge.svg?branch=master)](https://coveralls.io/github/Doraku/DefaultDocumentation?branch=master)
 
 - [Api documentation](./documentation/api/index.md 'Api documentation')
+- [Markdown documentation](./documentation/markdown/index.md 'Markdown documentation')
 <a/>
 
 - [Requirement](#Requirement)
@@ -420,6 +421,7 @@ The different `DocItem` types are:
 - `Name` or `DefaultDocumentation.Markdown.FileNameFactories.NameFactory DefaultDocumentation.Markdown` removes the namespace (collisions can happen if there is multiple types with the same name in different namespaces)
 - `Md5` or `DefaultDocumentation.Markdown.FileNameFactories.Md5Factory DefaultDocumentation.Markdown` uses a Md5 of the full name of each member to produce shorter name, collisions can happen
 - `NameAndMd5Mix` or `DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory DefaultDocumentation.Markdown` removes the namespace and use a Md5 for parameters
+- `DirectoryName` or `DefaultDocumentation.Markdown.FileNameFactories.DirectoryNameFactory DefaultDocumentation.Markdown` use a directory hierarchy
 The default value is `FullName`. All those implementations *WILL* delete any `.md` file *EXCEPT* a file named `readme.md`.
 
 <a name='DocItemConfiguration_Sections'></a>

diff --git a/documentation/DefaultDocumentation.Api.txt b/documentation/DefaultDocumentation.Api.txt
diff --git a/documentation/DefaultDocumentation.Markdown.txt b/documentation/DefaultDocumentation.Markdown.txt
diff --git a/documentation/NEXT_RELEASENOTES.txt b/documentation/NEXT_RELEASENOTES.txt
@@ -11,6 +11,7 @@
 - added OverloadsGenerator to put constructor and method overloads in the same page (closes #139)
 - added ExcludeGenerator to exclude DocItem from the documentation generation based on regex (closes #160)
 - list code and note elements now display a placeholder value `...` when displayed as a single line
+- added DirectoryName IFileNameFactory implementation (closes #104)
 
 ## Bug fixes
 

diff --git a/documentation/api/AssemblyDocItem.AssemblyDocItem(string,string,XElement).md b/documentation/api/AssemblyDocItem.AssemblyDocItem(string,string,XElement).md
diff --git a/documentation/api/AssemblyDocItem.md b/documentation/api/AssemblyDocItem.md
diff --git a/documentation/api/ClassDocItem.ClassDocItem(DocItem,ITypeDefinition,XElement).md b/documentation/api/ClassDocItem.ClassDocItem(DocItem,ITypeDefinition,XElement).md
diff --git a/documentation/api/ClassDocItem.md b/documentation/api/ClassDocItem.md
diff --git a/...tion/api/ConstructorDocItem.ConstructorDocItem(TypeDocItem,IMethod,XElement).md b/...tion/api/ConstructorDocItem.ConstructorDocItem(TypeDocItem,IMethod,XElement).md
diff --git a/documentation/api/ConstructorDocItem.Method.md b/documentation/api/ConstructorDocItem.Method.md
diff --git a/documentation/api/ConstructorDocItem.Parameters.md b/documentation/api/ConstructorDocItem.Parameters.md
diff --git a/documentation/api/ConstructorDocItem.md b/documentation/api/ConstructorDocItem.md
diff --git a/...on/api/DefaultDocumentation/Api/IDocItemGenerator/Generate(IDocItemsContext).md b/...on/api/DefaultDocumentation/Api/IDocItemGenerator/Generate(IDocItemsContext).md
@@ -0,0 +1,17 @@
+#### [DefaultDocumentation\.Api](../../../index.md 'index')
+### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IDocItemGenerator](index.md 'DefaultDocumentation\.Api\.IDocItemGenerator')
+
+## IDocItemGenerator\.Generate\(IDocItemsContext\) Method
+
+Modified the known [DocItem](../../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') of the [IDocItemsContext](../../IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext')\.
+
+```csharp
+void Generate(DefaultDocumentation.IDocItemsContext context);
+```
+#### Parameters
+
+<a name='DefaultDocumentation.Api.IDocItemGenerator.Generate(DefaultDocumentation.IDocItemsContext).context'></a>
+
+`context` [IDocItemsContext](../../IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext')
+
+The [IDocItemsContext](../../IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext') of the documentation generation\.
diff --git a/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/Name.md b/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/Name.md
@@ -0,0 +1,13 @@
+#### [DefaultDocumentation\.Api](../../../index.md 'index')
+### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IDocItemGenerator](index.md 'DefaultDocumentation\.Api\.IDocItemGenerator')
+
+## IDocItemGenerator\.Name Property
+
+Gets the name of the generator, used to identify it at the configuration level\.
+
+```csharp
+string Name { get; }
+```
+
+#### Property Value
+[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')
diff --git a/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/index.md b/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/index.md
@@ -0,0 +1,18 @@
+#### [DefaultDocumentation\.Api](../../../index.md 'index')
+### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api')
+
+## IDocItemGenerator Interface
+
+Exposes a method to generate the known [DocItem](../../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') of the documentation\.
+
+```csharp
+public interface IDocItemGenerator
+```
+
+| Properties | |
+| :--- | :--- |
+| [Name](Name.md 'DefaultDocumentation\.Api\.IDocItemGenerator\.Name') | Gets the name of the generator, used to identify it at the configuration level\. |
+
+| Methods | |
+| :--- | :--- |
+| [Generate\(IDocItemsContext\)](Generate(IDocItemsContext).md 'DefaultDocumentation\.Api\.IDocItemGenerator\.Generate\(DefaultDocumentation\.IDocItemsContext\)') | Modified the known [DocItem](../../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') of the [IDocItemsContext](../../IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext')\. |
diff --git a/documentation/api/DefaultDocumentation/Api/IElement/Name.md b/documentation/api/DefaultDocumentation/Api/IElement/Name.md
@@ -0,0 +1,13 @@
+#### [DefaultDocumentation\.Api](../../../index.md 'index')
+### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IElement](index.md 'DefaultDocumentation\.Api\.IElement')
+
+## IElement\.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
+string Name { get; }
+```
+
+#### Property Value
+[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')
diff --git a/documentation/api/DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md b/documentation/api/DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md
@@ -0,0 +1,23 @@
+#### [DefaultDocumentation\.Api](../../../index.md 'index')
+### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IElement](index.md 'DefaultDocumentation\.Api\.IElement')
+
+## IElement\.Write\(IWriter, XElement\) Method
+
+Writes to a [IWriter](../IWriter/index.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
+void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element);
+```
+#### Parameters
+
+<a name='DefaultDocumentation.Api.IElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement).writer'></a>
+
+`writer` [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')
+
+The [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\.
+
+<a name='DefaultDocumentation.Api.IElement.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\.
diff --git a/documentation/api/DefaultDocumentation/Api/IElement/index.md b/documentation/api/DefaultDocumentation/Api/IElement/index.md
@@ -0,0 +1,18 @@
+#### [DefaultDocumentation\.Api](../../../index.md 'index')
+### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api')
+
+## IElement Interface
+
+Exposes a method to handle a specific kind of [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') when writing documentation\.
+
+```csharp
+public interface IElement
+```
+
+| Properties | |
+| :--- | :--- |
+| [Name](Name.md 'DefaultDocumentation\.Api\.IElement\.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\)](Write(IWriter,XElement).md 'DefaultDocumentation\.Api\.IElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)') | Writes to a [IWriter](../IWriter/index.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')\. |