39 writes to Summary
Aspire.Hosting.CodeGeneration.Go.Tests (30)
GoDocCommentTests.cs (25)
370
Capability("withDocumentation", resourceType, new AtsDocumentationInfo {
Summary
= "Adds documentation to the resource.", Remarks = RichRemarks, Returns = "The resource builder." },
378
Capability("withObsoleteDocumentation", resourceType, new AtsDocumentationInfo {
Summary
= "Adds documentation using the legacy convention." },
381
Capability("withPreviewDocumentation", resourceType, new AtsDocumentationInfo {
Summary
= "Adds preview documentation." }, isExperimental: true),
382
Capability("withPreviewStatus", resourceType, new AtsDocumentationInfo {
Summary
= "Sets the preview status." },
384
Capability("withDirectOptions", resourceType, new AtsDocumentationInfo {
Summary
= "Applies the settings." },
386
Capability("withHeading", resourceType, new AtsDocumentationInfo {
Summary
= "Adds a heading.", Remarks = "Overview\n- first item" }),
389
Summary
= "Handles <special> characters & line endings.\r\nThe second line follows a CRLF.\rThe third line follows a CR.",
392
Capability("displayName", stringType, new AtsDocumentationInfo {
Summary
= "Gets or sets the display name." },
394
Capability("setDisplayName", resourceType, new AtsDocumentationInfo {
Summary
= "Gets or sets the display name." },
396
Capability("isEnabled", boolType, new AtsDocumentationInfo {
Summary
= "Gets or sets a value indicating whether the resource is enabled." },
398
Capability("port", Primitive(AtsConstants.Number), new AtsDocumentationInfo {
Summary
= "The port of the resource." },
400
Capability("tags", tagsType, new AtsDocumentationInfo {
Summary
= "Gets the tags of the resource." }, kind: AtsCapabilityKind.PropertyGetter),
401
Capability("getStatus", stringType, new AtsDocumentationInfo {
Summary
= "Gets the status of the resource.", Returns = "The status of the resource." }, kind: AtsCapabilityKind.InstanceMethod),
402
Capability("reset", voidType, new AtsDocumentationInfo {
Summary
= "Resets the resource to its defaults." },
411
Documentation = new AtsDocumentationInfo {
Summary
= "Represents a documented resource.", Remarks = "Create one with the builder." }
417
Documentation = new AtsDocumentationInfo {
Summary
= "Marks resources that carry documentation." }
426
Documentation = new AtsDocumentationInfo {
Summary
= "Represents the settings of a documented resource.", Remarks = "Settings are applied when the resource starts." },
429
new AtsDtoPropertyInfo { Name = "DisplayName", Type = stringType, Documentation = new AtsDocumentationInfo {
Summary
= "Gets or sets the display name." } },
430
new AtsDtoPropertyInfo { Name = "Enabled", Type = boolType, Documentation = new AtsDocumentationInfo {
Summary
= "Gets or sets a value indicating whether the resource is enabled." } },
444
Documentation = new AtsDocumentationInfo {
Summary
= "Describes the lifecycle state of a documented resource." },
447
new AtsEnumValueInfo { Name = nameof(DocumentedStatus.Pending), Documentation = new AtsDocumentationInfo {
Summary
= "The resource is pending." } },
448
new AtsEnumValueInfo { Name = nameof(DocumentedStatus.Running), Documentation = new AtsDocumentationInfo {
Summary
= "Indicates that the resource is running.", Remarks = "It accepts requests." } },
449
new AtsEnumValueInfo { Name = nameof(DocumentedStatus.Retired), Documentation = new AtsDocumentationInfo {
Summary
= "A resource that was retired." } }
461
Documentation = new AtsDocumentationInfo {
Summary
= "The primary settings." }
482
Documentation = summary is null ? null : new AtsDocumentationInfo {
Summary
= summary }
GoGeneratorEscapingTests.cs (5)
110
documentation: new AtsDocumentationInfo {
Summary
= InjectedText, Remarks = InjectedText, Returns = InjectedText },
140
new AtsTypeInfo { AtsTypeId = ResourceTypeId, Documentation = new AtsDocumentationInfo {
Summary
= InjectedText } }
150
new AtsDtoPropertyInfo { Name = "Bad\"Name", Type = stringType, Documentation = new AtsDocumentationInfo {
Summary
= InjectedText } },
164
ValueInfos = [new AtsEnumValueInfo { Name = nameof(EscapedStatus.Ready), Documentation = new AtsDocumentationInfo {
Summary
= InjectedText } }]
206
Documentation = summary is null ? null : new AtsDocumentationInfo {
Summary
= summary }
Aspire.Hosting.CodeGeneration.TypeScript.Tests (3)
AtsTypeScriptCodeGeneratorTests.cs (3)
251
documentation: new AtsDocumentationInfo {
Summary
= "Configures an experimental feature." },
356
Summary
= "Runs a void capability.",
378
Summary
= "Configures {@ats-ref type:TestRedisResource} from ATS documentation."
Aspire.Hosting.Native.CodeGeneration (3)
src\Aspire.Hosting.RemoteHost\AtsCapabilityScanner.cs (3)
3612
Summary
= summary,
3641
return summary is null ? null : new AtsDocumentationInfo {
Summary
= summary };
3654
: new AtsDocumentationInfo {
Summary
= parameter.Description };
Aspire.Hosting.RemoteHost (3)
AtsCapabilityScanner.cs (3)
3612
Summary
= summary,
3641
return summary is null ? null : new AtsDocumentationInfo {
Summary
= summary };
3654
: new AtsDocumentationInfo {
Summary
= parameter.Description };
53 references to Summary
Aspire.Hosting.CodeGeneration.Go (16)
AtsGoCodeGenerator.ApiProjection.cs (5)
445
Summary = leaf.Value.Documentation?.
Summary
?? leaf.Value.Description,
499
summary: handleType?.Documentation?.
Summary
,
776
Summary = capability.Documentation?.
Summary
?? capability.Description,
799
Summary = parameter.Documentation?.
Summary
,
820
Summary = parameter.Documentation?.
Summary
AtsGoCodeGenerator.cs (11)
682
.Select(p => new GoDocParameter(p.Name, GetLocalIdentifier(p.Name), isSetter ? null : p.Documentation?.
Summary
))
689
? directOptionsParam.Documentation?.
Summary
?? $"Optional parameters; see {RenderTypeLink(MapDtoType(directOptionsParam.Type!.TypeId))}."
705
Summary = capability.Documentation?.
Summary
,
750
Summary = enumType.Documentation?.
Summary
,
767
Summary = memberDocumentation?.
Summary
,
807
Summary = dto.Documentation?.
Summary
?? dto.Description,
834
Summary = property.Documentation?.
Summary
?? property.Description,
913
Summary = valueInfo.Documentation?.
Summary
?? valueInfo.Description,
1116
Summary = documentation?.
Summary
,
1268
Summary = documentation?.
Summary
,
2147
Summary = capability.CapabilityKind == AtsCapabilityKind.PropertySetter ? null : p.Documentation?.
Summary
,
Aspire.Hosting.CodeGeneration.Go.Tests (1)
GoDocCommentTests.cs (1)
208
var documentedValues = context.EnumTypes.SelectMany(e => e.ValueInfos).Count(v => !string.IsNullOrWhiteSpace(v.Documentation?.
Summary
));
Aspire.Hosting.CodeGeneration.TypeScript (16)
AtsTypeScriptCodeGenerator.cs (2)
122
.Select(p => (p.Name, Summary: p.Documentation?.
Summary
))
171
AddDocumentationLines(lines, documentation?.
Summary
?? fallbackSummary);
TypeScriptApiProjector.cs (14)
338
Summary = directOptionsParam?.Documentation?.
Summary
368
Summary = parameter.Documentation?.
Summary
730
Summary = valueInfo.Documentation?.
Summary
?? valueInfo.Description,
804
AddDocumentationLines(lines, documentation?.
Summary
?? fallbackSummary);
1108
Summary = documentation?.
Summary
,
1161
Summary = capability.Documentation?.
Summary
,
1222
Summary = documentation?.
Summary
,
1245
Summary = capability.Documentation?.
Summary
,
1296
Summary = parameter.Documentation?.
Summary
1338
Summary = value.Documentation?.
Summary
,
1351
Summary = enumType.Documentation?.
Summary
,
1410
Summary = property.Documentation?.
Summary
?? property.Description,
1434
Summary = dtoType.Documentation?.
Summary
,
1467
Summary = param.Documentation?.
Summary
,
Aspire.Hosting.CodeGeneration.TypeScript.Tests (7)
AtsTypeScriptCodeGeneratorTests.cs (7)
184
Assert.Equal("Adds a test Redis resource from ATS documentation.", addTestRedis.Documentation?.
Summary
);
189
Assert.Equal("The ATS resource name.", nameParameter.Documentation?.
Summary
);
195
Assert.Equal("Test DTO to verify [AspireDto] generates TypeScript interfaces.", testConfig.Documentation?.
Summary
);
196
Assert.Equal("The name of the test config.", testConfig.Properties.First(p => p.Name == nameof(TestConfigDto.Name)).Documentation?.
Summary
);
199
Assert.Equal("Test enum for type generation verification.", testStatus.Documentation?.
Summary
);
200
Assert.Equal("The resource is pending.", testStatus.ValueInfos.First(v => v.Name == nameof(TestResourceStatus.Pending)).Documentation?.
Summary
);
203
Assert.Equal("The default test configuration.", defaultConfig.Documentation?.
Summary
);
Aspire.Hosting.Native.CodeGeneration (5)
src\Aspire.Hosting.RemoteHost\AtsCapabilityScanner.cs (5)
1150
var typeDescription = typeDocumentation?.
Summary
;
1194
var propDescription = propDocumentation?.
Summary
;
1744
var propertyDescription = memberExportAttr?.Description ?? propertyDocumentation?.
Summary
?? $"Gets the {property.Name} property";
1944
var description = memberExportAttr?.Description ?? methodDocumentation?.
Summary
?? $"Invokes the {method.Name} method";
2124
var description = exportAttr.Description ?? methodDocumentation?.
Summary
;
Aspire.Hosting.RemoteHost (6)
AtsCapabilityScanner.cs (5)
1150
var typeDescription = typeDocumentation?.
Summary
;
1194
var propDescription = propDocumentation?.
Summary
;
1744
var propertyDescription = memberExportAttr?.Description ?? propertyDocumentation?.
Summary
?? $"Gets the {property.Name} property";
1944
var description = memberExportAttr?.Description ?? methodDocumentation?.
Summary
?? $"Invokes the {method.Name} method";
2124
var description = exportAttr.Description ?? methodDocumentation?.
Summary
;
CodeGeneration\CodeGenerationService.cs (1)
219
Summary = documentation.
Summary
,
Aspire.Hosting.RemoteHost.Tests (2)
AtsCapabilityScannerTests.cs (2)
875
Assert.Equal("Uses the description as fallback documentation.", capability.Documentation?.
Summary
);
876
Assert.Equal("The fallback value.", Assert.Single(capability.Parameters).Documentation?.
Summary
);