From 34958e2d59b92335310169a140170f66e3b9a015 Mon Sep 17 00:00:00 2001 From: dvolper Date: Thu, 23 May 2024 10:29:03 +0200 Subject: [PATCH] regenerate docs --- .../Doki/Doki.AssemblyDocumentation.md | 6 +-- .../Doki.Abstractions/Doki/Doki.CodeBlock.md | 4 +- .../Doki/Doki.DocumentationContentType.md | 38 +++++++++---------- .../Doki/Doki.DocumentationObject.md | 6 +-- .../Doki.GenericTypeArgumentDocumentation.md | 4 +- docs/api/Doki.Abstractions/Doki/Doki.Link.md | 4 +- .../Doki/Doki.MemberDocumentation.md | 10 ++--- .../Doki/Doki.TextContent.md | 2 +- .../Doki/Doki.TypeDocumentation.md | 18 ++++----- .../Doki/Doki.TypeDocumentationReference.md | 12 +++--- .../Doki.Output/Doki.Output.IOutput.md | 4 +- .../Doki/Doki/Doki.DocumentationGenerator.md | 26 ++++++------- docs/api/Doki/Doki/Doki.Filter_1.md | 8 ++-- src/Doki/DocumentationGenerator.Content.cs | 2 +- 14 files changed, 72 insertions(+), 72 deletions(-) diff --git a/docs/api/Doki.Abstractions/Doki/Doki.AssemblyDocumentation.md b/docs/api/Doki.Abstractions/Doki/Doki.AssemblyDocumentation.md index 4a5b99f..7771826 100644 --- a/docs/api/Doki.Abstractions/Doki/Doki.AssemblyDocumentation.md +++ b/docs/api/Doki.Abstractions/Doki/Doki.AssemblyDocumentation.md @@ -34,9 +34,9 @@ Implements: [System.IEquatable<Doki.AssemblyDocumentation>](https://learn. | |Summary| |---|---| |EqualityContract|| -|FileName|Gets the name of the assembly.| -|Version|Gets the version of the assembly.| -|PackageId|Gets the NuGet package ID of the assembly.| +|FileName| Gets the name of the assembly.| +|Version| Gets the version of the assembly.| +|PackageId| Gets the NuGet package ID of the assembly.| |Name|| |Description|| |Namespaces|| diff --git a/docs/api/Doki.Abstractions/Doki/Doki.CodeBlock.md b/docs/api/Doki.Abstractions/Doki/Doki.CodeBlock.md index 1b6463e..2100593 100644 --- a/docs/api/Doki.Abstractions/Doki/Doki.CodeBlock.md +++ b/docs/api/Doki.Abstractions/Doki/Doki.CodeBlock.md @@ -34,8 +34,8 @@ Implements: [System.IEquatable<Doki.CodeBlock>](https://learn.microsoft.co | |Summary| |---|---| |EqualityContract|| -|Language|Gets the language of the code block.| -|Code|Gets the code of the block.| +|Language| Gets the language of the code block.| +|Code| Gets the code of the block.| ## Methods diff --git a/docs/api/Doki.Abstractions/Doki/Doki.DocumentationContentType.md b/docs/api/Doki.Abstractions/Doki/Doki.DocumentationContentType.md index 22b0339..261d78e 100644 --- a/docs/api/Doki.Abstractions/Doki/Doki.DocumentationContentType.md +++ b/docs/api/Doki.Abstractions/Doki/Doki.DocumentationContentType.md @@ -24,24 +24,24 @@ Inheritance: [System.Object](https://learn.microsoft.com/en-us/dotnet/api/System | |Summary| |---|---| -|Object|An object in the documentation. This is the default content type.| -|Root|The root of the documentation, containing all assemblies/packages.| -|Assembly|An assembly in the documentation.| -|Namespace|A namespace in the documentation.| -|TypeReference|A type reference in the documentation.| -|Class|A class in the documentation.| -|Enum|An enum in the documentation.| -|Struct|A struct in the documentation.| -|Interface|An interface in the documentation.| -|Type|A type.| -|GenericTypeArgument|A generic type argument.| -|Xml|A xml content.| -|Text|A text content.| -|CodeBlock|A code block.| -|Link|A link.| -|Constructor|A constructor in the documentation.| -|Field|A field in the documentation.| -|Property|A property in the documentation.| -|Method|A method in the documentation.| +|Object| An object in the documentation. This is the default content type.| +|Root| The root of the documentation, containing all assemblies/packages.| +|Assembly| An assembly in the documentation.| +|Namespace| A namespace in the documentation.| +|TypeReference| A type reference in the documentation.| +|Class| A class in the documentation.| +|Enum| An enum in the documentation.| +|Struct| A struct in the documentation.| +|Interface| An interface in the documentation.| +|Type| A type.| +|GenericTypeArgument| A generic type argument.| +|Xml| A xml content.| +|Text| A text content.| +|CodeBlock| A code block.| +|Link| A link.| +|Constructor| A constructor in the documentation.| +|Field| A field in the documentation.| +|Property| A property in the documentation.| +|Method| A method in the documentation.| diff --git a/docs/api/Doki.Abstractions/Doki/Doki.DocumentationObject.md b/docs/api/Doki.Abstractions/Doki/Doki.DocumentationObject.md index 6b99133..511af9c 100644 --- a/docs/api/Doki.Abstractions/Doki/Doki.DocumentationObject.md +++ b/docs/api/Doki.Abstractions/Doki/Doki.DocumentationObject.md @@ -37,9 +37,9 @@ Implements: [System.IEquatable<Doki.DocumentationObject>](https://learn.mi | |Summary| |---|---| |EqualityContract|| -|Id|Gets the ID of the documentation object.| -|Parent|Gets the parent of the documentation object.| -|ContentType|Gets the content type of the documentation object.| +|Id| Gets the ID of the documentation object.| +|Parent| Gets the parent of the documentation object.| +|ContentType| Gets the content type of the documentation object.| ## Methods diff --git a/docs/api/Doki.Abstractions/Doki/Doki.GenericTypeArgumentDocumentation.md b/docs/api/Doki.Abstractions/Doki/Doki.GenericTypeArgumentDocumentation.md index 2826b98..5cac84b 100644 --- a/docs/api/Doki.Abstractions/Doki/Doki.GenericTypeArgumentDocumentation.md +++ b/docs/api/Doki.Abstractions/Doki/Doki.GenericTypeArgumentDocumentation.md @@ -34,8 +34,8 @@ Implements: [System.IEquatable<Doki.GenericTypeArgumentDocumentation>](htt | |Summary| |---|---| |EqualityContract|| -|Description|Gets the description of the generic type argument.| -|IsGenericParameter|Gets a value indicating whether the generic type argument is a generic parameter.| +|Description| Gets the description of the generic type argument.| +|IsGenericParameter| Gets a value indicating whether the generic type argument is a generic parameter.| ## Methods diff --git a/docs/api/Doki.Abstractions/Doki/Doki.Link.md b/docs/api/Doki.Abstractions/Doki/Doki.Link.md index 5be9a50..e1f3a27 100644 --- a/docs/api/Doki.Abstractions/Doki/Doki.Link.md +++ b/docs/api/Doki.Abstractions/Doki/Doki.Link.md @@ -34,8 +34,8 @@ Implements: [System.IEquatable<Doki.Link>](https://learn.microsoft.com/en- | |Summary| |---|---| |EqualityContract|| -|Url|Gets the URL of the link.| -|Text|Gets the text of the link.| +|Url| Gets the URL of the link.| +|Text| Gets the text of the link.| ## Methods diff --git a/docs/api/Doki.Abstractions/Doki/Doki.MemberDocumentation.md b/docs/api/Doki.Abstractions/Doki/Doki.MemberDocumentation.md index 4c1c4a9..2bcce29 100644 --- a/docs/api/Doki.Abstractions/Doki/Doki.MemberDocumentation.md +++ b/docs/api/Doki.Abstractions/Doki/Doki.MemberDocumentation.md @@ -37,11 +37,11 @@ Implements: [System.IEquatable<Doki.MemberDocumentation>](https://learn.mi | |Summary| |---|---| |EqualityContract|| -|Name|Gets the name of the member.| -|Namespace|Gets the namespace of the member.| -|Assembly|Gets the assembly of the member.| -|Summary|Gets the summary of the member.| -|IsDocumented|Gets a value indicating whether the type is documented.| +|Name| Gets the name of the member.| +|Namespace| Gets the namespace of the member.| +|Assembly| Gets the assembly of the member.| +|Summary| Gets the summary of the member.| +|IsDocumented| Gets a value indicating whether the type is documented.| |ContentType|| diff --git a/docs/api/Doki.Abstractions/Doki/Doki.TextContent.md b/docs/api/Doki.Abstractions/Doki/Doki.TextContent.md index e40e7a7..aaeb651 100644 --- a/docs/api/Doki.Abstractions/Doki/Doki.TextContent.md +++ b/docs/api/Doki.Abstractions/Doki/Doki.TextContent.md @@ -34,7 +34,7 @@ Implements: [System.IEquatable<Doki.TextContent>](https://learn.microsoft. | |Summary| |---|---| |EqualityContract|| -|Text|Gets the text content.| +|Text| Gets the text content.| ## Methods diff --git a/docs/api/Doki.Abstractions/Doki/Doki.TypeDocumentation.md b/docs/api/Doki.Abstractions/Doki/Doki.TypeDocumentation.md index f692a26..9c502d6 100644 --- a/docs/api/Doki.Abstractions/Doki/Doki.TypeDocumentation.md +++ b/docs/api/Doki.Abstractions/Doki/Doki.TypeDocumentation.md @@ -34,15 +34,15 @@ Implements: [System.IEquatable<Doki.TypeDocumentation>](https://learn.micr | |Summary| |---|---| |EqualityContract|| -|Definition|Gets the definition of the type.| -|Examples|Get the examples of the type.| -|Remarks|Gets the remarks of the type.| -|Interfaces|Gets the interfaces implemented by the type.| -|DerivedTypes|Gets the derived types of the type.| -|Constructors|Gets the constructors of the type.| -|Fields|Gets the fields of the type.| -|Properties|Gets the properties of the type.| -|Methods|Gets the methods of the type.| +|Definition| Gets the definition of the type.| +|Examples| Get the examples of the type.| +|Remarks| Gets the remarks of the type.| +|Interfaces| Gets the interfaces implemented by the type.| +|DerivedTypes| Gets the derived types of the type.| +|Constructors| Gets the constructors of the type.| +|Fields| Gets the fields of the type.| +|Properties| Gets the properties of the type.| +|Methods| Gets the methods of the type.| |ContentType|| diff --git a/docs/api/Doki.Abstractions/Doki/Doki.TypeDocumentationReference.md b/docs/api/Doki.Abstractions/Doki/Doki.TypeDocumentationReference.md index a215511..c0aa7ff 100644 --- a/docs/api/Doki.Abstractions/Doki/Doki.TypeDocumentationReference.md +++ b/docs/api/Doki.Abstractions/Doki/Doki.TypeDocumentationReference.md @@ -28,7 +28,7 @@ Implements: [System.IEquatable<Doki.TypeDocumentationReference>](https://l | |Summary| |---|---| -|TypeDocumentationReference()|Initializes a new instance of the [TypeDocumentationReference](Doki.TypeDocumentationReference.md) class.| +|TypeDocumentationReference()| Initializes a new instance of the [TypeDocumentationReference](Doki.TypeDocumentationReference.md) class.| |TypeDocumentationReference(Doki.TypeDocumentationReference)|| @@ -37,11 +37,11 @@ Implements: [System.IEquatable<Doki.TypeDocumentationReference>](https://l | |Summary| |---|---| |EqualityContract|| -|IsGeneric|Gets a value indicating whether the type is generic.| -|FullName|Gets the full name of the type.| -|IsMicrosoft|Gets a value indicating whether the type is from Microsoft.| -|BaseType|Gets the base type of the type.| -|GenericArguments|Gets the generic arguments of the type.| +|IsGeneric| Gets a value indicating whether the type is generic.| +|FullName| Gets the full name of the type.| +|IsMicrosoft| Gets a value indicating whether the type is from Microsoft.| +|BaseType| Gets the base type of the type.| +|GenericArguments| Gets the generic arguments of the type.| ## Methods diff --git a/docs/api/Doki.Output.Abstractions/Doki.Output/Doki.Output.IOutput.md b/docs/api/Doki.Output.Abstractions/Doki.Output/Doki.Output.IOutput.md index ed7c49d..454124f 100644 --- a/docs/api/Doki.Output.Abstractions/Doki.Output/Doki.Output.IOutput.md +++ b/docs/api/Doki.Output.Abstractions/Doki.Output/Doki.Output.IOutput.md @@ -24,9 +24,9 @@ public interface IOutput |---|---| |BeginAsync(System.Threading.CancellationToken)|| |EndAsync(System.Threading.CancellationToken)|| -|WriteAsync(Doki.DocumentationRoot, System.Threading.CancellationToken)|Writes the documentation.| +|WriteAsync(Doki.DocumentationRoot, System.Threading.CancellationToken)| Writes the documentation.| |WriteAsync(Doki.AssemblyDocumentation, System.Threading.CancellationToken)|| |WriteAsync(Doki.NamespaceDocumentation, System.Threading.CancellationToken)|| -|WriteAsync(Doki.TypeDocumentation, System.Threading.CancellationToken)|Writes a specific type documentation.| +|WriteAsync(Doki.TypeDocumentation, System.Threading.CancellationToken)| Writes a specific type documentation.| diff --git a/docs/api/Doki/Doki/Doki.DocumentationGenerator.md b/docs/api/Doki/Doki/Doki.DocumentationGenerator.md index f065b2b..65d8e40 100644 --- a/docs/api/Doki/Doki/Doki.DocumentationGenerator.md +++ b/docs/api/Doki/Doki/Doki.DocumentationGenerator.md @@ -22,7 +22,7 @@ Inheritance: [System.Object](https://learn.microsoft.com/en-us/dotnet/api/System ## Examples -The following example shows how to generate documentation for an assembly and output it using the [MarkdownOutput](../../Doki.Output.Markdown/Doki.Output.Markdown/Doki.Output.Markdown.MarkdownOutput.md) class. + The following example shows how to generate documentation for an assembly and output it using the [MarkdownOutput](../../Doki.Output.Markdown/Doki.Output.Markdown/Doki.Output.Markdown.MarkdownOutput.md) class. ```csharp var outputContext = new OutputContext(Directory.GetCurrentDirectory()); @@ -38,35 +38,35 @@ await generator.GenerateAsync(new ConsoleLogger()); ## Remarks -You can also use the doki cli tool to generate documentation. See the official [documentation](https://github.com/DavidVollmers/doki) for more information. + You can also use the doki cli tool to generate documentation. See the official [documentation](https://github.com/DavidVollmers/doki) for more information. ## Constructors | |Summary| |---|---| -|DocumentationGenerator()|Initializes a new instance of the [DocumentationGenerator](Doki.DocumentationGenerator.md) class.| +|DocumentationGenerator()| Initializes a new instance of the [DocumentationGenerator](Doki.DocumentationGenerator.md) class.| |DocumentationGenerator(System.IServiceProvider)|| -|DocumentationGenerator(System.Reflection.Assembly, System.Xml.XPath.XPathDocument)|Initializes a new instance of the [DocumentationGenerator](Doki.DocumentationGenerator.md) class with the specified assembly and xml documentation.| +|DocumentationGenerator(System.Reflection.Assembly, System.Xml.XPath.XPathDocument)| Initializes a new instance of the [DocumentationGenerator](Doki.DocumentationGenerator.md) class with the specified assembly and xml documentation.| ## Properties | |Summary| |---|---| -|TypeFilter|Gets the filter for types to include in the documentation.| -|ConstructorFilter|Gets the filter for constructors to include in the documentation.| -|FieldFilter|Gets the filter for fields to include in the documentation.| -|PropertyFilter|Gets the filter for properties to include in the documentation.| -|MethodFilter|Gets the filter for methods to include in the documentation.| -|IncludeInheritedMembers|Gets or sets a value indicating whether to include inherited members in the documentation.| +|TypeFilter| Gets the filter for types to include in the documentation.| +|ConstructorFilter| Gets the filter for constructors to include in the documentation.| +|FieldFilter| Gets the filter for fields to include in the documentation.| +|PropertyFilter| Gets the filter for properties to include in the documentation.| +|MethodFilter| Gets the filter for methods to include in the documentation.| +|IncludeInheritedMembers| Gets or sets a value indicating whether to include inherited members in the documentation.| ## Methods | |Summary| |---|---| -|AddAssembly(System.Reflection.Assembly, System.Xml.XPath.XPathDocument, System.Xml.XPath.XPathDocument)|Adds an assembly to generate documentation for.| -|AddOutput(Doki.Output.IOutput)|Adds an output to write the documentation to.| -|GenerateAsync(Microsoft.Extensions.Logging.ILogger, System.Threading.CancellationToken)|Generates the documentation for the assemblies and writes it to the outputs.| +|AddAssembly(System.Reflection.Assembly, System.Xml.XPath.XPathDocument, System.Xml.XPath.XPathDocument)| Adds an assembly to generate documentation for.| +|AddOutput(Doki.Output.IOutput)| Adds an output to write the documentation to.| +|GenerateAsync(Microsoft.Extensions.Logging.ILogger, System.Threading.CancellationToken)| Generates the documentation for the assemblies and writes it to the outputs.| diff --git a/docs/api/Doki/Doki/Doki.Filter_1.md b/docs/api/Doki/Doki/Doki.Filter_1.md index 256e2a9..98cf125 100644 --- a/docs/api/Doki/Doki/Doki.Filter_1.md +++ b/docs/api/Doki/Doki/Doki.Filter_1.md @@ -24,7 +24,7 @@ Inheritance: [System.Object](https://learn.microsoft.com/en-us/dotnet/api/System - `T` - The type of the collection. + The type of the collection. @@ -32,14 +32,14 @@ Inheritance: [System.Object](https://learn.microsoft.com/en-us/dotnet/api/System | |Summary| |---|---| -|Filter(Func<T, System.Boolean>)|Creates a new filter with the given default filter.| +|Filter(Func<T, System.Boolean>)| Creates a new filter with the given default filter.| ## Properties | |Summary| |---|---| -|Default|Gets the default filter.| -|Expression|Gets or sets the expression to filter the collection.| +|Default| Gets the default filter.| +|Expression| Gets or sets the expression to filter the collection.| diff --git a/src/Doki/DocumentationGenerator.Content.cs b/src/Doki/DocumentationGenerator.Content.cs index dabac66..3261071 100644 --- a/src/Doki/DocumentationGenerator.Content.cs +++ b/src/Doki/DocumentationGenerator.Content.cs @@ -313,7 +313,7 @@ private XmlDocumentation BuildXmlDocumentation(XPathNavigator navigator, Documen Id = node.Name, Parent = content, Language = language, - Code = node.Value.TrimIndentation() + Code = node.Value.TrimIndentation().TrimEnd() }); break; default: