Skip to content

Commit 19e41f7

Browse files
SpelkingtonSpelkington
committed
docs: docs update
1 parent fa9a28c commit 19e41f7

196 files changed

Lines changed: 29308 additions & 629 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/project.json‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"projectType": "library",
55
"sourceRoot": "./docs",
66
"targets": {
7-
"build:reference": {
7+
"_build-reference": {
88
"//": "Generates markdown API reference from C# docstrings into docs/reference/src/",
99
"executor": "nx:run-commands",
1010
"dependsOn": [ "flowthru:restore" ],
@@ -14,6 +14,17 @@
1414
],
1515
"parallel": false
1616
}
17+
},
18+
"build": {
19+
"//": "Generates markdown API reference from C# docstrings into docs/reference/src/",
20+
"executor": "nx:run-commands",
21+
"dependsOn": [ "_build-reference" ],
22+
"options": {
23+
"commands": [
24+
"echo 'Docs Build Complete!'"
25+
],
26+
"parallel": false
27+
}
1728
}
1829
}
1930
}

‎docs/reference/src/core/Flowthru.Core.CodeFixes/Flowthru.Core.CodeFixes.Ft1001AddPartialKeywordFix.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# <a id="Flowthru_Core_CodeFixes_Ft1001AddPartialKeywordFix"></a> Class Ft1001AddPartialKeywordFix
2+
3+
Namespace: [Flowthru.Core.CodeFixes](Flowthru.Core.CodeFixes.md)
4+
Assembly: Flowthru.Core.CodeFixes.dll
5+
6+
Code fix for FT1001: adds the <code>partial</code> modifier to a type annotated with
7+
<code>[FlowthruSchema]</code> that is missing the keyword.
8+
9+
```csharp
10+
[ExportCodeFixProvider("C#", new string[] { }, Name = "Ft1001AddPartialKeywordFix")]
11+
[Shared]
12+
public sealed class Ft1001AddPartialKeywordFix : CodeFixProvider
13+
```
14+
15+
#### Inheritance
16+
17+
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
18+
[CodeFixProvider](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider) ←
19+
[Ft1001AddPartialKeywordFix](Flowthru.Core.CodeFixes.Ft1001AddPartialKeywordFix.md)
20+
21+
#### Inherited Members
22+
23+
[CodeFixProvider.RegisterCodeFixesAsync\(CodeFixContext\)](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider.registercodefixesasync),
24+
[CodeFixProvider.GetFixAllProvider\(\)](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider.getfixallprovider),
25+
[CodeFixProvider.FixableDiagnosticIds](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider.fixablediagnosticids),
26+
[CodeFixProvider.RequestPriority](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider.requestpriority),
27+
[object.Equals\(object\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
28+
[object.Equals\(object, object\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
29+
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
30+
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
31+
[object.ReferenceEquals\(object, object\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
32+
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
33+
34+
## Properties
35+
36+
### <a id="Flowthru_Core_CodeFixes_Ft1001AddPartialKeywordFix_FixableDiagnosticIds"></a> FixableDiagnosticIds
37+
38+
A list of diagnostic IDs that this provider can provide fixes for.
39+
40+
```csharp
41+
public override ImmutableArray<string> FixableDiagnosticIds { get; }
42+
```
43+
44+
#### Property Value
45+
46+
[ImmutableArray](https://learn.microsoft.com/dotnet/api/system.collections.immutable.immutablearray\-1)<[string](https://learn.microsoft.com/dotnet/api/system.string)\>
47+
48+
## Methods
49+
50+
### <a id="Flowthru_Core_CodeFixes_Ft1001AddPartialKeywordFix_GetFixAllProvider"></a> GetFixAllProvider\(\)
51+
52+
Gets an optional <xref href="Microsoft.CodeAnalysis.CodeFixes.FixAllProvider" data-throw-if-not-resolved="false"></xref> that can fix all/multiple occurrences of diagnostics fixed by this code fix provider.
53+
Return null if the provider doesn't support fix all/multiple occurrences.
54+
Otherwise, you can return any of the well known fix all providers from <xref href="Microsoft.CodeAnalysis.CodeFixes.WellKnownFixAllProviders" data-throw-if-not-resolved="false"></xref> or implement your own fix all provider.
55+
56+
```csharp
57+
public override FixAllProvider GetFixAllProvider()
58+
```
59+
60+
#### Returns
61+
62+
[FixAllProvider](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.fixallprovider)
63+
64+
### <a id="Flowthru_Core_CodeFixes_Ft1001AddPartialKeywordFix_RegisterCodeFixesAsync_Microsoft_CodeAnalysis_CodeFixes_CodeFixContext_"></a> RegisterCodeFixesAsync\(CodeFixContext\)
65+
66+
Computes one or more fixes for the specified <xref href="Microsoft.CodeAnalysis.CodeFixes.CodeFixContext" data-throw-if-not-resolved="false"></xref>.
67+
68+
```csharp
69+
public override Task RegisterCodeFixesAsync(CodeFixContext context)
70+
```
71+
72+
#### Parameters
73+
74+
`context` [CodeFixContext](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixcontext)
75+
76+
A <xref href="Microsoft.CodeAnalysis.CodeFixes.CodeFixContext" data-throw-if-not-resolved="false"></xref> containing context information about the diagnostics to fix.
77+
The context must only contain diagnostics with a <xref href="Microsoft.CodeAnalysis.Diagnostic.Id" data-throw-if-not-resolved="false"></xref> included in the <xref href="Microsoft.CodeAnalysis.CodeFixes.CodeFixProvider.FixableDiagnosticIds" data-throw-if-not-resolved="false"></xref> for the current provider.
78+
79+
#### Returns
80+
81+
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
82+

‎docs/reference/src/core/Flowthru.Core.CodeFixes/Flowthru.Core.CodeFixes.Ft1002RemoveConflictingInterfaceFix.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# <a id="Flowthru_Core_CodeFixes_Ft1002RemoveConflictingInterfaceFix"></a> Class Ft1002RemoveConflictingInterfaceFix
2+
3+
Namespace: [Flowthru.Core.CodeFixes](Flowthru.Core.CodeFixes.md)
4+
Assembly: Flowthru.Core.CodeFixes.dll
5+
6+
Code fix for FT1002: removes the conflicting manually-applied marker interface(s)
7+
from a <code>[FlowthruSchema]</code> type's base list.
8+
The generator will re-apply the correct interfaces automatically.
9+
10+
```csharp
11+
[ExportCodeFixProvider("C#", new string[] { }, Name = "Ft1002RemoveConflictingInterfaceFix")]
12+
[Shared]
13+
public sealed class Ft1002RemoveConflictingInterfaceFix : CodeFixProvider
14+
```
15+
16+
#### Inheritance
17+
18+
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
19+
[CodeFixProvider](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider) ←
20+
[Ft1002RemoveConflictingInterfaceFix](Flowthru.Core.CodeFixes.Ft1002RemoveConflictingInterfaceFix.md)
21+
22+
#### Inherited Members
23+
24+
[CodeFixProvider.RegisterCodeFixesAsync\(CodeFixContext\)](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider.registercodefixesasync),
25+
[CodeFixProvider.GetFixAllProvider\(\)](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider.getfixallprovider),
26+
[CodeFixProvider.FixableDiagnosticIds](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider.fixablediagnosticids),
27+
[CodeFixProvider.RequestPriority](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider.requestpriority),
28+
[object.Equals\(object\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
29+
[object.Equals\(object, object\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
30+
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
31+
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
32+
[object.ReferenceEquals\(object, object\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
33+
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
34+
35+
## Properties
36+
37+
### <a id="Flowthru_Core_CodeFixes_Ft1002RemoveConflictingInterfaceFix_FixableDiagnosticIds"></a> FixableDiagnosticIds
38+
39+
A list of diagnostic IDs that this provider can provide fixes for.
40+
41+
```csharp
42+
public override ImmutableArray<string> FixableDiagnosticIds { get; }
43+
```
44+
45+
#### Property Value
46+
47+
[ImmutableArray](https://learn.microsoft.com/dotnet/api/system.collections.immutable.immutablearray\-1)<[string](https://learn.microsoft.com/dotnet/api/system.string)\>
48+
49+
## Methods
50+
51+
### <a id="Flowthru_Core_CodeFixes_Ft1002RemoveConflictingInterfaceFix_GetFixAllProvider"></a> GetFixAllProvider\(\)
52+
53+
Gets an optional <xref href="Microsoft.CodeAnalysis.CodeFixes.FixAllProvider" data-throw-if-not-resolved="false"></xref> that can fix all/multiple occurrences of diagnostics fixed by this code fix provider.
54+
Return null if the provider doesn't support fix all/multiple occurrences.
55+
Otherwise, you can return any of the well known fix all providers from <xref href="Microsoft.CodeAnalysis.CodeFixes.WellKnownFixAllProviders" data-throw-if-not-resolved="false"></xref> or implement your own fix all provider.
56+
57+
```csharp
58+
public override FixAllProvider GetFixAllProvider()
59+
```
60+
61+
#### Returns
62+
63+
[FixAllProvider](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.fixallprovider)
64+
65+
### <a id="Flowthru_Core_CodeFixes_Ft1002RemoveConflictingInterfaceFix_RegisterCodeFixesAsync_Microsoft_CodeAnalysis_CodeFixes_CodeFixContext_"></a> RegisterCodeFixesAsync\(CodeFixContext\)
66+
67+
Computes one or more fixes for the specified <xref href="Microsoft.CodeAnalysis.CodeFixes.CodeFixContext" data-throw-if-not-resolved="false"></xref>.
68+
69+
```csharp
70+
public override Task RegisterCodeFixesAsync(CodeFixContext context)
71+
```
72+
73+
#### Parameters
74+
75+
`context` [CodeFixContext](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixcontext)
76+
77+
A <xref href="Microsoft.CodeAnalysis.CodeFixes.CodeFixContext" data-throw-if-not-resolved="false"></xref> containing context information about the diagnostics to fix.
78+
The context must only contain diagnostics with a <xref href="Microsoft.CodeAnalysis.Diagnostic.Id" data-throw-if-not-resolved="false"></xref> included in the <xref href="Microsoft.CodeAnalysis.CodeFixes.CodeFixProvider.FixableDiagnosticIds" data-throw-if-not-resolved="false"></xref> for the current provider.
79+
80+
#### Returns
81+
82+
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
83+

‎docs/reference/src/core/Flowthru.Core.CodeFixes/Flowthru.Core.CodeFixes.Ft2002RemoveUnusedCatalogFix.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# <a id="Flowthru_Core_CodeFixes_Ft2002RemoveUnusedCatalogFix"></a> Class Ft2002RemoveUnusedCatalogFix
2+
3+
Namespace: [Flowthru.Core.CodeFixes](Flowthru.Core.CodeFixes.md)
4+
Assembly: Flowthru.Core.CodeFixes.dll
5+
6+
Code fix for FT2002: removes the <code>RegisterCatalog</code> call that is registered
7+
but never referenced by any flow.
8+
9+
```csharp
10+
[ExportCodeFixProvider("C#", new string[] { }, Name = "Ft2002RemoveUnusedCatalogFix")]
11+
[Shared]
12+
public sealed class Ft2002RemoveUnusedCatalogFix : CodeFixProvider
13+
```
14+
15+
#### Inheritance
16+
17+
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
18+
[CodeFixProvider](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider) ←
19+
[Ft2002RemoveUnusedCatalogFix](Flowthru.Core.CodeFixes.Ft2002RemoveUnusedCatalogFix.md)
20+
21+
#### Inherited Members
22+
23+
[CodeFixProvider.RegisterCodeFixesAsync\(CodeFixContext\)](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider.registercodefixesasync),
24+
[CodeFixProvider.GetFixAllProvider\(\)](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider.getfixallprovider),
25+
[CodeFixProvider.FixableDiagnosticIds](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider.fixablediagnosticids),
26+
[CodeFixProvider.RequestPriority](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider.requestpriority),
27+
[object.Equals\(object\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
28+
[object.Equals\(object, object\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
29+
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
30+
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
31+
[object.ReferenceEquals\(object, object\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
32+
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
33+
34+
## Properties
35+
36+
### <a id="Flowthru_Core_CodeFixes_Ft2002RemoveUnusedCatalogFix_FixableDiagnosticIds"></a> FixableDiagnosticIds
37+
38+
A list of diagnostic IDs that this provider can provide fixes for.
39+
40+
```csharp
41+
public override ImmutableArray<string> FixableDiagnosticIds { get; }
42+
```
43+
44+
#### Property Value
45+
46+
[ImmutableArray](https://learn.microsoft.com/dotnet/api/system.collections.immutable.immutablearray\-1)<[string](https://learn.microsoft.com/dotnet/api/system.string)\>
47+
48+
## Methods
49+
50+
### <a id="Flowthru_Core_CodeFixes_Ft2002RemoveUnusedCatalogFix_GetFixAllProvider"></a> GetFixAllProvider\(\)
51+
52+
Gets an optional <xref href="Microsoft.CodeAnalysis.CodeFixes.FixAllProvider" data-throw-if-not-resolved="false"></xref> that can fix all/multiple occurrences of diagnostics fixed by this code fix provider.
53+
Return null if the provider doesn't support fix all/multiple occurrences.
54+
Otherwise, you can return any of the well known fix all providers from <xref href="Microsoft.CodeAnalysis.CodeFixes.WellKnownFixAllProviders" data-throw-if-not-resolved="false"></xref> or implement your own fix all provider.
55+
56+
```csharp
57+
public override FixAllProvider GetFixAllProvider()
58+
```
59+
60+
#### Returns
61+
62+
[FixAllProvider](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.fixallprovider)
63+
64+
### <a id="Flowthru_Core_CodeFixes_Ft2002RemoveUnusedCatalogFix_RegisterCodeFixesAsync_Microsoft_CodeAnalysis_CodeFixes_CodeFixContext_"></a> RegisterCodeFixesAsync\(CodeFixContext\)
65+
66+
Computes one or more fixes for the specified <xref href="Microsoft.CodeAnalysis.CodeFixes.CodeFixContext" data-throw-if-not-resolved="false"></xref>.
67+
68+
```csharp
69+
public override Task RegisterCodeFixesAsync(CodeFixContext context)
70+
```
71+
72+
#### Parameters
73+
74+
`context` [CodeFixContext](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.codefixes.codefixcontext)
75+
76+
A <xref href="Microsoft.CodeAnalysis.CodeFixes.CodeFixContext" data-throw-if-not-resolved="false"></xref> containing context information about the diagnostics to fix.
77+
The context must only contain diagnostics with a <xref href="Microsoft.CodeAnalysis.Diagnostic.Id" data-throw-if-not-resolved="false"></xref> included in the <xref href="Microsoft.CodeAnalysis.CodeFixes.CodeFixProvider.FixableDiagnosticIds" data-throw-if-not-resolved="false"></xref> for the current provider.
78+
79+
#### Returns
80+
81+
[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)
82+

‎docs/reference/src/core/Flowthru.Core.CodeFixes/Flowthru.Core.CodeFixes.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# <a id="Flowthru_Core_CodeFixes"></a> Namespace Flowthru.Core.CodeFixes
2+
3+
### Classes
4+
5+
[Ft1001AddPartialKeywordFix](Flowthru.Core.CodeFixes.Ft1001AddPartialKeywordFix.md)
6+
7+
Code fix for FT1001: adds the <code>partial</code> modifier to a type annotated with
8+
<code>[FlowthruSchema]</code> that is missing the keyword.
9+
10+
[Ft1002RemoveConflictingInterfaceFix](Flowthru.Core.CodeFixes.Ft1002RemoveConflictingInterfaceFix.md)
11+
12+
Code fix for FT1002: removes the conflicting manually-applied marker interface(s)
13+
from a <code>[FlowthruSchema]</code> type's base list.
14+
The generator will re-apply the correct interfaces automatically.
15+
16+
[Ft2002RemoveUnusedCatalogFix](Flowthru.Core.CodeFixes.Ft2002RemoveUnusedCatalogFix.md)
17+
18+
Code fix for FT2002: removes the <code>RegisterCatalog</code> call that is registered
19+
but never referenced by any flow.
20+

‎docs/reference/src/core/Flowthru.Core.CodeFixes/toc.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
### YamlMime:TableOfContent
2+
- name: Flowthru.Core.CodeFixes
3+
href: Flowthru.Core.CodeFixes.md
4+
items:
5+
- name: Classes
6+
- name: Ft1001AddPartialKeywordFix
7+
href: Flowthru.Core.CodeFixes.Ft1001AddPartialKeywordFix.md
8+
- name: Ft1002RemoveConflictingInterfaceFix
9+
href: Flowthru.Core.CodeFixes.Ft1002RemoveConflictingInterfaceFix.md
10+
- name: Ft2002RemoveUnusedCatalogFix
11+
href: Flowthru.Core.CodeFixes.Ft2002RemoveUnusedCatalogFix.md

0 commit comments

Comments
 (0)