From 482202d83e4d9b1dd16f61d1ffb55f606c64a1ee Mon Sep 17 00:00:00 2001 From: dvolper Date: Sun, 5 May 2024 19:42:31 +0200 Subject: [PATCH] docs --- .../Doki.Output/Doki.Output.IOutput.md | 2 ++ .../Doki.Output.OutputOptionsExtensions.md | 27 +++++++++++++++++++ .../Doki.Output.OutputOptions_1.md | 1 + .../Doki.Output/README.md | 1 + ....Output.ClassLibrary.ClassLibraryOutput.md | 1 + .../Doki.Output.Markdown.MarkdownOutput.md | 1 + doki.config.json | 2 +- 7 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 docs/api/Doki.Output.Abstractions/Doki.Output/Doki.Output.OutputOptionsExtensions.md 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 b56a0ce..b15d91f 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 @@ -22,6 +22,8 @@ public interface IOutput | |Summary| |---|---| +|BeginAsync(System.Threading.CancellationToken)|| +|EndAsync(System.Threading.CancellationToken)|| |WriteAsync(Doki.ContentList, System.Threading.CancellationToken)|Writes the content list to the output.| |WriteAsync(Doki.TypeDocumentation, System.Threading.CancellationToken)|Writes the type documentation to the output.| diff --git a/docs/api/Doki.Output.Abstractions/Doki.Output/Doki.Output.OutputOptionsExtensions.md b/docs/api/Doki.Output.Abstractions/Doki.Output/Doki.Output.OutputOptionsExtensions.md new file mode 100644 index 0000000..452254c --- /dev/null +++ b/docs/api/Doki.Output.Abstractions/Doki.Output/Doki.Output.OutputOptionsExtensions.md @@ -0,0 +1,27 @@ +[Packages](../../README.md) / [Doki.Output.Abstractions](../README.md) / [Doki.Output](README.md) / + +# OutputOptionsExtensions Class + +## Definition + +Namespace: [Doki.Output](README.md) + +Assembly: [Doki.Output.Abstractions.dll](../README.md) + +Package: [Doki.Output.Abstractions](https://www.nuget.org/packages/Doki.Output.Abstractions) + +--- + +```csharp +public static class OutputOptionsExtensions +``` + +Inheritance: [System.Object](https://learn.microsoft.com/en-us/dotnet/api/System.Object) → OutputOptionsExtensions + +## Methods + +| |Summary| +|---|---| +|ClearOutputDirectoryIfRequired<T>(OutputOptions<T>)|| + + diff --git a/docs/api/Doki.Output.Abstractions/Doki.Output/Doki.Output.OutputOptions_1.md b/docs/api/Doki.Output.Abstractions/Doki.Output/Doki.Output.OutputOptions_1.md index 0d409f0..8a79bb2 100644 --- a/docs/api/Doki.Output.Abstractions/Doki.Output/Doki.Output.OutputOptions_1.md +++ b/docs/api/Doki.Output.Abstractions/Doki.Output/Doki.Output.OutputOptions_1.md @@ -41,6 +41,7 @@ Implements: [IEquatable<Doki.Output.OutputOptions<T>>](https://learn |---|---| |EqualityContract|| |OutputDirectory|| +|ClearOutput|| ## Methods diff --git a/docs/api/Doki.Output.Abstractions/Doki.Output/README.md b/docs/api/Doki.Output.Abstractions/Doki.Output/README.md index 3bf9153..26c9551 100644 --- a/docs/api/Doki.Output.Abstractions/Doki.Output/README.md +++ b/docs/api/Doki.Output.Abstractions/Doki.Output/README.md @@ -4,5 +4,6 @@ - [IOutput](Doki.Output.IOutput.md) - [OutputOptions<T>](Doki.Output.OutputOptions_1.md) +- [OutputOptionsExtensions](Doki.Output.OutputOptionsExtensions.md) diff --git a/docs/api/Doki.Output.ClassLibrary/Doki.Output.ClassLibrary/Doki.Output.ClassLibrary.ClassLibraryOutput.md b/docs/api/Doki.Output.ClassLibrary/Doki.Output.ClassLibrary/Doki.Output.ClassLibrary.ClassLibraryOutput.md index f33083b..65d081b 100644 --- a/docs/api/Doki.Output.ClassLibrary/Doki.Output.ClassLibrary/Doki.Output.ClassLibrary.ClassLibraryOutput.md +++ b/docs/api/Doki.Output.ClassLibrary/Doki.Output.ClassLibrary/Doki.Output.ClassLibrary.ClassLibraryOutput.md @@ -31,6 +31,7 @@ Implements: [IOutput](../../Doki.Output.Abstractions/Doki.Output/Doki.Output.IOu | |Summary| |---|---| +|BeginAsync(System.Threading.CancellationToken)|| |WriteAsync(Doki.ContentList, System.Threading.CancellationToken)|| |WriteAsync(Doki.TypeDocumentation, System.Threading.CancellationToken)|| diff --git a/docs/api/Doki.Output.Markdown/Doki.Output.Markdown/Doki.Output.Markdown.MarkdownOutput.md b/docs/api/Doki.Output.Markdown/Doki.Output.Markdown/Doki.Output.Markdown.MarkdownOutput.md index e030ec5..c5edf0d 100644 --- a/docs/api/Doki.Output.Markdown/Doki.Output.Markdown/Doki.Output.Markdown.MarkdownOutput.md +++ b/docs/api/Doki.Output.Markdown/Doki.Output.Markdown/Doki.Output.Markdown.MarkdownOutput.md @@ -31,6 +31,7 @@ Implements: [IOutput](../../Doki.Output.Abstractions/Doki.Output/Doki.Output.IOu | |Summary| |---|---| +|BeginAsync(System.Threading.CancellationToken)|| |WriteAsync(Doki.ContentList, System.Threading.CancellationToken)|| |WriteAsync(Doki.TypeDocumentation, System.Threading.CancellationToken)|| diff --git a/doki.config.json b/doki.config.json index dbd079e..77cc994 100644 --- a/doki.config.json +++ b/doki.config.json @@ -16,7 +16,7 @@ "type": "Doki.Output.ClassLibrary", "from": "src/Doki.Output.ClassLibrary/Doki.Output.ClassLibrary.csproj", "options": { - "outputPath": "src", + "outputPath": "src/Doki.Documentation.Content", "namespace": "Doki.Documentation.Content" } }