40 instantiations of AtsDocumentationInfo
Aspire.Hosting.CodeGeneration.Go.Tests (30)
GoDocCommentTests.cs (25)
460
Capability("withDocumentation", resourceType, new
AtsDocumentationInfo
{ Summary = "Adds documentation to the resource.", Remarks = RichRemarks, Returns = "The resource builder." },
468
Capability("withObsoleteDocumentation", resourceType, new
AtsDocumentationInfo
{ Summary = "Adds documentation using the legacy convention." },
471
Capability("withPreviewDocumentation", resourceType, new
AtsDocumentationInfo
{ Summary = "Adds preview documentation." }, isExperimental: true),
472
Capability("withPreviewStatus", resourceType, new
AtsDocumentationInfo
{ Summary = "Sets the preview status." },
474
Capability("withDirectOptions", resourceType, new
AtsDocumentationInfo
{ Summary = "Applies the settings." },
476
Capability("withHeading", resourceType, new
AtsDocumentationInfo
{ Summary = "Adds a heading.", Remarks = "Overview\n- first item" }),
477
Capability("withSpecialText", resourceType, new
AtsDocumentationInfo
482
Capability("displayName", stringType, new
AtsDocumentationInfo
{ Summary = "Gets or sets the display name." },
484
Capability("setDisplayName", resourceType, new
AtsDocumentationInfo
{ Summary = "Gets or sets the display name." },
486
Capability("isEnabled", boolType, new
AtsDocumentationInfo
{ Summary = "Gets or sets a value indicating whether the resource is enabled." },
488
Capability("port", Primitive(AtsConstants.Number), new
AtsDocumentationInfo
{ Summary = "The port of the resource." },
490
Capability("tags", tagsType, new
AtsDocumentationInfo
{ Summary = "Gets the tags of the resource." }, kind: AtsCapabilityKind.PropertyGetter),
491
Capability("getStatus", stringType, new
AtsDocumentationInfo
{ Summary = "Gets the status of the resource.", Returns = "The status of the resource." }, kind: AtsCapabilityKind.InstanceMethod),
492
Capability("reset", voidType, new
AtsDocumentationInfo
{ Summary = "Resets the resource to its defaults." },
501
Documentation = new
AtsDocumentationInfo
{ Summary = "Represents a documented resource.", Remarks = "Create one with the builder." }
507
Documentation = new
AtsDocumentationInfo
{ Summary = "Marks resources that carry documentation." }
516
Documentation = new
AtsDocumentationInfo
{ Summary = "Represents the settings of a documented resource.", Remarks = "Settings are applied when the resource starts." },
519
new AtsDtoPropertyInfo { Name = "DisplayName", Type = stringType, Documentation = new
AtsDocumentationInfo
{ Summary = "Gets or sets the display name." } },
520
new AtsDtoPropertyInfo { Name = "Enabled", Type = boolType, Documentation = new
AtsDocumentationInfo
{ Summary = "Gets or sets a value indicating whether the resource is enabled." } },
534
Documentation = new
AtsDocumentationInfo
{ Summary = "Describes the lifecycle state of a documented resource." },
537
new AtsEnumValueInfo { Name = nameof(DocumentedStatus.Pending), Documentation = new
AtsDocumentationInfo
{ Summary = "The resource is pending." } },
538
new AtsEnumValueInfo { Name = nameof(DocumentedStatus.Running), Documentation = new
AtsDocumentationInfo
{ Summary = "Indicates that the resource is running.", Remarks = "It accepts requests." } },
539
new AtsEnumValueInfo { Name = nameof(DocumentedStatus.Retired), Documentation = new
AtsDocumentationInfo
{ Summary = "A resource that was retired." } }
551
Documentation = new
AtsDocumentationInfo
{ Summary = "The primary settings." }
572
Documentation = summary is null ? null : new
AtsDocumentationInfo
{ Summary = summary }
GoGeneratorEscapingTests.cs (5)
134
documentation: new
AtsDocumentationInfo
{ Summary = InjectedText, Remarks = InjectedText, Returns = InjectedText },
166
new AtsTypeInfo { AtsTypeId = ResourceTypeId, Documentation = new
AtsDocumentationInfo
{ Summary = InjectedText } }
176
new AtsDtoPropertyInfo { Name = "Bad\"Name", Type = stringType, Documentation = new
AtsDocumentationInfo
{ Summary = InjectedText } },
190
ValueInfos = [new AtsEnumValueInfo { Name = nameof(EscapedStatus.Ready), Documentation = new
AtsDocumentationInfo
{ Summary = InjectedText } }]
232
Documentation = summary is null ? null : new
AtsDocumentationInfo
{ Summary = summary }
Aspire.Hosting.CodeGeneration.TypeScript.Tests (4)
AtsTypeScriptCodeGeneratorTests.cs (4)
232
documentation: new
AtsDocumentationInfo
());
250
documentation: new
AtsDocumentationInfo
{ Summary = "Configures an experimental feature." },
353
documentation: new
AtsDocumentationInfo
375
documentation: new
AtsDocumentationInfo
Aspire.Hosting.Native.CodeGeneration (3)
src\Aspire.Hosting.RemoteHost\AtsCapabilityScanner.cs (3)
3623
return new
AtsDocumentationInfo
3654
return summary is null ? null : new
AtsDocumentationInfo
{ Summary = summary };
3667
: new
AtsDocumentationInfo
{ Summary = parameter.Description };
Aspire.Hosting.RemoteHost (3)
AtsCapabilityScanner.cs (3)
3623
return new
AtsDocumentationInfo
3654
return summary is null ? null : new
AtsDocumentationInfo
{ Summary = summary };
3667
: new
AtsDocumentationInfo
{ Summary = parameter.Description };
55 references to AtsDocumentationInfo
Aspire.Hosting.CodeGeneration.Go (4)
AtsGoCodeGenerator.cs (4)
81
private readonly Dictionary<string,
AtsDocumentationInfo
> _handleDocumentation = new(StringComparer.Ordinal);
1033
if (valueDocumentation.TryGetValue(member, out
var
memberDocumentation))
1383
var
documentation = _handleDocumentation.GetValueOrDefault(typeId);
1535
var
documentation = _handleDocumentation.GetValueOrDefault(typeId);
Aspire.Hosting.CodeGeneration.Go.Tests (2)
GoDocCommentTests.cs (1)
578
AtsDocumentationInfo
? documentation = null,
GoGeneratorEscapingTests.cs (1)
248
AtsDocumentationInfo
? documentation = null,
Aspire.Hosting.CodeGeneration.TypeScript (8)
AtsTypeScriptCodeGenerator.cs (2)
161
AtsDocumentationInfo
? documentation,
630
private
AtsDocumentationInfo
? GetHandleDocumentation(string typeId)
TypeScriptApiProjector.cs (6)
120
internal Dictionary<string,
AtsDocumentationInfo
> HandleDocumentationById => _handleDocumentationById;
800
AtsDocumentationInfo
? documentation,
1012
var
documentation = _handleDocumentationById.GetValueOrDefault(builderModel.TypeId);
1097
AtsDocumentationInfo
? documentation,
1214
var
documentation = getter?.Documentation ?? setter?.Documentation;
1606
private readonly Dictionary<string,
AtsDocumentationInfo
> _handleDocumentationById = new(StringComparer.Ordinal);
Aspire.Hosting.CodeGeneration.TypeScript.Tests (1)
AtsTypeScriptCodeGeneratorTests.cs (1)
2126
AtsDocumentationInfo
documentation,
Aspire.Hosting.Native.CodeGeneration (15)
src\Aspire.Hosting.RemoteHost\AtsCapabilityScanner.cs (15)
1156
var
typeDocumentation = GetXmlDocumentation(type);
1200
var
propDocumentation = GetXmlDocumentation(prop);
1756
var
propertyDocumentation = GetXmlDocumentation(property, memberExportAttr?.Description);
1956
var
methodDocumentation = GetXmlDocumentation(method, memberExportAttr?.Description);
2136
var
methodDocumentation = GetXmlDocumentation(method, exportAttr.Description);
2141
var
parameterDocumentation = GetParameterDocumentation(methodDocumentation, param.Name);
2193
AtsDocumentationInfo
? documentation = null)
2279
var
invokeDocumentation = GetXmlDocumentation(invokeMethod);
3543
private static
AtsDocumentationInfo
? GetXmlDocumentation(MemberInfo? member, string? fallbackSummary = null)
3559
private static
AtsDocumentationInfo
? GetXmlDocumentation(XDocument? xmlDoc, string memberName, string? fallbackSummary = null)
3562
var
documentation = CreateDocumentation(memberElement, fallbackSummary);
3582
private static
AtsDocumentationInfo
? CreateDocumentation(XElement? memberElement, string? fallbackSummary)
3651
private static
AtsDocumentationInfo
? CreateFallbackDocumentation(string? fallbackSummary)
3657
private static
AtsDocumentationInfo
? GetParameterDocumentation(
AtsDocumentationInfo
? documentation, string? parameterName)
Aspire.Hosting.RemoteHost (16)
AtsCapabilityScanner.cs (15)
1156
var
typeDocumentation = GetXmlDocumentation(type);
1200
var
propDocumentation = GetXmlDocumentation(prop);
1756
var
propertyDocumentation = GetXmlDocumentation(property, memberExportAttr?.Description);
1956
var
methodDocumentation = GetXmlDocumentation(method, memberExportAttr?.Description);
2136
var
methodDocumentation = GetXmlDocumentation(method, exportAttr.Description);
2141
var
parameterDocumentation = GetParameterDocumentation(methodDocumentation, param.Name);
2193
AtsDocumentationInfo
? documentation = null)
2279
var
invokeDocumentation = GetXmlDocumentation(invokeMethod);
3543
private static
AtsDocumentationInfo
? GetXmlDocumentation(MemberInfo? member, string? fallbackSummary = null)
3559
private static
AtsDocumentationInfo
? GetXmlDocumentation(XDocument? xmlDoc, string memberName, string? fallbackSummary = null)
3562
var
documentation = CreateDocumentation(memberElement, fallbackSummary);
3582
private static
AtsDocumentationInfo
? CreateDocumentation(XElement? memberElement, string? fallbackSummary)
3651
private static
AtsDocumentationInfo
? CreateFallbackDocumentation(string? fallbackSummary)
3657
private static
AtsDocumentationInfo
? GetParameterDocumentation(
AtsDocumentationInfo
? documentation, string? parameterName)
CodeGeneration\CodeGenerationService.cs (1)
210
private static DocumentationResponse? MapDocumentation(
AtsDocumentationInfo
? documentation)
Aspire.TypeSystem (9)
AtsCapabilityInfo.cs (8)
232
public
AtsDocumentationInfo
? Documentation { get; init; }
296
public
AtsDocumentationInfo
? Documentation { get; init; }
426
public
AtsDocumentationInfo
? Documentation { get; init; }
447
public
AtsDocumentationInfo
? Documentation { get; init; }
504
public
AtsDocumentationInfo
? Documentation { get; init; }
537
public
AtsDocumentationInfo
? Documentation { get; init; }
597
public
AtsDocumentationInfo
? Documentation { get; init; }
645
public
AtsDocumentationInfo
? Documentation { get; init; }
AtsExportedValueInfo.cs (1)
45
public
AtsDocumentationInfo
? Documentation { get; init; }