Skip to content

Commit

Permalink
generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidVollmers committed May 7, 2024
1 parent 5090b8f commit 8264633
Show file tree
Hide file tree
Showing 8 changed files with 99 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
docs/json

## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
[Packages](../../README.md) / [Doki.Output.Json](../README.md) / [Doki.Output.Json](README.md) /

# JsonOutput Class

## Definition

Namespace: [Doki.Output.Json](README.md)

Assembly: [Doki.Output.Json.dll](../README.md)

Package: [Doki.Output.Json](https://www.nuget.org/packages/Doki.Output.Json)

---

```csharp
public sealed class JsonOutput : Doki.Output.IOutput
```

Inheritance: [System.Object](https://learn.microsoft.com/en-us/dotnet/api/System.Object) → JsonOutput

Implements: [IOutput](../../Doki.Output.Abstractions/Doki.Output/Doki.Output.IOutput.md)

## Constructors

| |Summary|
|---|---|
|JsonOutput(Doki.Output.OutputOptions<Doki.Output.Json.JsonOutput>)||


## Methods

| |Summary|
|---|---|
|BeginAsync(System.Threading.CancellationToken)||
|WriteAsync(Doki.DocumentationRoot, System.Threading.CancellationToken)||


Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[Packages](../../README.md) / [Doki.Output.Json](../README.md) / [Doki.Output.Json](README.md) /

# JsonOutputExtensions Class

## Definition

Namespace: [Doki.Output.Json](README.md)

Assembly: [Doki.Output.Json.dll](../README.md)

Package: [Doki.Output.Json](https://www.nuget.org/packages/Doki.Output.Json)

---

```csharp
public static class JsonOutputExtensions
```

Inheritance: [System.Object](https://learn.microsoft.com/en-us/dotnet/api/System.Object) → JsonOutputExtensions

## Methods

| |Summary|
|---|---|
|AddMarkdownOutput(Microsoft.Extensions.DependencyInjection.IServiceCollection)||


8 changes: 8 additions & 0 deletions docs/api/Doki.Output.Json/Doki.Output.Json/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Doki.Output.Json Namespace

## Types

- [JsonOutput](Doki.Output.Json.JsonOutput.md)
- [JsonOutputExtensions](Doki.Output.Json.JsonOutputExtensions.md)


9 changes: 9 additions & 0 deletions docs/api/Doki.Output.Json/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Doki.Output.Json

Doki JSON Generator

## Namespaces

- [Doki.Output.Json](Doki.Output.Json/README.md)


4 changes: 4 additions & 0 deletions docs/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@

Doki Output Extensions

- [Doki.Output.Json](Doki.Output.Json/README.md)

Doki JSON Generator

- [Doki.Output.Markdown](Doki.Output.Markdown/README.md)

Doki Markdown Generator
Expand Down
10 changes: 8 additions & 2 deletions doki.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
"$schema": "src/Doki.CommandLine/doki.config.schema.json",
"input": [
"src/**/*.csproj",
"!src/Doki.CommandLine/Doki.CommandLine.csproj",
"!src/Doki.Documentation.Content/Doki.Documentation.Content.csproj"
"!src/Doki.CommandLine/Doki.CommandLine.csproj"
],
"output": [
{
Expand All @@ -12,6 +11,13 @@
"options": {
"outputPath": "docs/api"
}
},
{
"type": "Doki.Output.Json",
"from": "src/Doki.Output.Json/Doki.Output.Json.csproj",
"options": {
"outputPath": "docs/json"
}
}
]
}
5 changes: 4 additions & 1 deletion src/Doki.Abstractions/DocumentationObject.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
namespace Doki;
using System.Text.Json.Serialization;

namespace Doki;

/// <summary>
/// Represents a documentation object.
Expand All @@ -13,6 +15,7 @@ public abstract record DocumentationObject
/// <summary>
/// Gets the parent of the documentation object.
/// </summary>
[JsonIgnore]
public DocumentationObject? Parent { get; internal init; }

/// <summary>
Expand Down

0 comments on commit 8264633

Please sign in to comment.