Skip to content

Commit

Permalink
generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidVollmers committed Jun 22, 2024
1 parent 39b27f3 commit 46ba5fc
Show file tree
Hide file tree
Showing 7 changed files with 51 additions and 8 deletions.
4 changes: 3 additions & 1 deletion docs/api/Doki.Abstractions/Doki/Doki.MemberDocumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ Implements: [System.IEquatable<Doki.MemberDocumentation>](https://learn.mi
|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.|
|Summaries| Gets the summary of the member.|
|Examples| Get the examples of the member.|
|Remarks| Gets the remarks of the member.|
|IsDocumented| Gets a value indicating whether the type is documented.|
|ContentType||

Expand Down
2 changes: 0 additions & 2 deletions docs/api/Doki.Abstractions/Doki/Doki.TypeDocumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ Implements: [System.IEquatable<Doki.TypeDocumentation>](https://learn.micr
|---|---|
|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.|
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[Packages](../../README.md) / [Doki.Extensions](../README.md) / [Doki.Extensions](README.md) /

# DocumentationObjectExtensions Class

## Definition

Namespace: [Doki.Extensions](README.md)

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

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

---

```csharp
public static class DocumentationObjectExtensions
```

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

## Methods

| |Summary|
|---|---|
|TryGetParent(Doki.DocumentationRoot, Doki.DocumentationObject)||


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

## Types

- [DocumentationObjectExtensions](Doki.Extensions.DocumentationObjectExtensions.md)


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

Provides extensions for Doki documentation generation

## Namespaces

- [Doki.Extensions](Doki.Extensions/README.md)


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

Provides abstractions for Doki documentation generation

- [Doki.Extensions](Doki.Extensions/README.md)

Provides extensions for Doki documentation generation

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

Provides abstractions for Doki output generation
Expand Down
6 changes: 1 addition & 5 deletions src/Doki.Output.Markdown/MarkdownOutput.cs
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,6 @@ public async Task WriteAsync(TypeDocumentation typeDocumentation, CancellationTo
foreach (var summary in constructor.Summaries)
{
text.Append(markdown.BuildText(summary));
text.NewLine();
}

table.AddRow(new Text(constructor.Name), text);
Expand All @@ -236,9 +235,8 @@ public async Task WriteAsync(TypeDocumentation typeDocumentation, CancellationTo
foreach (var summary in field.Summaries)
{
text.Append(markdown.BuildText(summary));
text.NewLine();
}

table.AddRow(new Text(field.Name), text);
}

Expand All @@ -256,7 +254,6 @@ public async Task WriteAsync(TypeDocumentation typeDocumentation, CancellationTo
foreach (var summary in property.Summaries)
{
text.Append(markdown.BuildText(summary));
text.NewLine();
}

table.AddRow(new Text(property.Name), text);
Expand All @@ -276,7 +273,6 @@ public async Task WriteAsync(TypeDocumentation typeDocumentation, CancellationTo
foreach (var summary in method.Summaries)
{
text.Append(markdown.BuildText(summary));
text.NewLine();
}

table.AddRow(new Text(method.Name), text);
Expand Down

0 comments on commit 46ba5fc

Please sign in to comment.