40 instantiations of AtsDocumentationInfo
Aspire.Hosting.CodeGeneration.Go.Tests (30)
GoDocCommentTests.cs (25)
370Capability("withDocumentation", resourceType, new AtsDocumentationInfo { Summary = "Adds documentation to the resource.", Remarks = RichRemarks, Returns = "The resource builder." }, 378Capability("withObsoleteDocumentation", resourceType, new AtsDocumentationInfo { Summary = "Adds documentation using the legacy convention." }, 381Capability("withPreviewDocumentation", resourceType, new AtsDocumentationInfo { Summary = "Adds preview documentation." }, isExperimental: true), 382Capability("withPreviewStatus", resourceType, new AtsDocumentationInfo { Summary = "Sets the preview status." }, 384Capability("withDirectOptions", resourceType, new AtsDocumentationInfo { Summary = "Applies the settings." }, 386Capability("withHeading", resourceType, new AtsDocumentationInfo { Summary = "Adds a heading.", Remarks = "Overview\n- first item" }), 387Capability("withSpecialText", resourceType, new AtsDocumentationInfo 392Capability("displayName", stringType, new AtsDocumentationInfo { Summary = "Gets or sets the display name." }, 394Capability("setDisplayName", resourceType, new AtsDocumentationInfo { Summary = "Gets or sets the display name." }, 396Capability("isEnabled", boolType, new AtsDocumentationInfo { Summary = "Gets or sets a value indicating whether the resource is enabled." }, 398Capability("port", Primitive(AtsConstants.Number), new AtsDocumentationInfo { Summary = "The port of the resource." }, 400Capability("tags", tagsType, new AtsDocumentationInfo { Summary = "Gets the tags of the resource." }, kind: AtsCapabilityKind.PropertyGetter), 401Capability("getStatus", stringType, new AtsDocumentationInfo { Summary = "Gets the status of the resource.", Returns = "The status of the resource." }, kind: AtsCapabilityKind.InstanceMethod), 402Capability("reset", voidType, new AtsDocumentationInfo { Summary = "Resets the resource to its defaults." }, 411Documentation = new AtsDocumentationInfo { Summary = "Represents a documented resource.", Remarks = "Create one with the builder." } 417Documentation = new AtsDocumentationInfo { Summary = "Marks resources that carry documentation." } 426Documentation = new AtsDocumentationInfo { Summary = "Represents the settings of a documented resource.", Remarks = "Settings are applied when the resource starts." }, 429new AtsDtoPropertyInfo { Name = "DisplayName", Type = stringType, Documentation = new AtsDocumentationInfo { Summary = "Gets or sets the display name." } }, 430new AtsDtoPropertyInfo { Name = "Enabled", Type = boolType, Documentation = new AtsDocumentationInfo { Summary = "Gets or sets a value indicating whether the resource is enabled." } }, 444Documentation = new AtsDocumentationInfo { Summary = "Describes the lifecycle state of a documented resource." }, 447new AtsEnumValueInfo { Name = nameof(DocumentedStatus.Pending), Documentation = new AtsDocumentationInfo { Summary = "The resource is pending." } }, 448new AtsEnumValueInfo { Name = nameof(DocumentedStatus.Running), Documentation = new AtsDocumentationInfo { Summary = "Indicates that the resource is running.", Remarks = "It accepts requests." } }, 449new AtsEnumValueInfo { Name = nameof(DocumentedStatus.Retired), Documentation = new AtsDocumentationInfo { Summary = "A resource that was retired." } } 461Documentation = new AtsDocumentationInfo { Summary = "The primary settings." } 482Documentation = summary is null ? null : new AtsDocumentationInfo { Summary = summary }
GoGeneratorEscapingTests.cs (5)
110documentation: new AtsDocumentationInfo { Summary = InjectedText, Remarks = InjectedText, Returns = InjectedText }, 140new AtsTypeInfo { AtsTypeId = ResourceTypeId, Documentation = new AtsDocumentationInfo { Summary = InjectedText } } 150new AtsDtoPropertyInfo { Name = "Bad\"Name", Type = stringType, Documentation = new AtsDocumentationInfo { Summary = InjectedText } }, 164ValueInfos = [new AtsEnumValueInfo { Name = nameof(EscapedStatus.Ready), Documentation = new AtsDocumentationInfo { Summary = InjectedText } }] 206Documentation = summary is null ? null : new AtsDocumentationInfo { Summary = summary }
Aspire.Hosting.CodeGeneration.TypeScript.Tests (4)
AtsTypeScriptCodeGeneratorTests.cs (4)
233documentation: new AtsDocumentationInfo()); 251documentation: new AtsDocumentationInfo { Summary = "Configures an experimental feature." }, 354documentation: new AtsDocumentationInfo 376documentation: new AtsDocumentationInfo
Aspire.Hosting.Native.CodeGeneration (3)
src\Aspire.Hosting.RemoteHost\AtsCapabilityScanner.cs (3)
3610return new AtsDocumentationInfo 3641return summary is null ? null : new AtsDocumentationInfo { Summary = summary }; 3654: new AtsDocumentationInfo { Summary = parameter.Description };
Aspire.Hosting.RemoteHost (3)
AtsCapabilityScanner.cs (3)
3610return new AtsDocumentationInfo 3641return summary is null ? null : new AtsDocumentationInfo { Summary = summary }; 3654: new AtsDocumentationInfo { Summary = parameter.Description };
55 references to AtsDocumentationInfo
Aspire.Hosting.CodeGeneration.Go (4)
AtsGoCodeGenerator.cs (4)
76private readonly Dictionary<string, AtsDocumentationInfo> _handleDocumentation = new(StringComparer.Ordinal); 761if (valueDocumentation.TryGetValue(member, out var memberDocumentation)) 1111var documentation = _handleDocumentation.GetValueOrDefault(typeId); 1263var documentation = _handleDocumentation.GetValueOrDefault(typeId);
Aspire.Hosting.CodeGeneration.Go.Tests (2)
GoDocCommentTests.cs (1)
488AtsDocumentationInfo? documentation = null,
GoGeneratorEscapingTests.cs (1)
222AtsDocumentationInfo? documentation = null,
Aspire.Hosting.CodeGeneration.TypeScript (8)
AtsTypeScriptCodeGenerator.cs (2)
161AtsDocumentationInfo? documentation, 630private AtsDocumentationInfo? GetHandleDocumentation(string typeId)
TypeScriptApiProjector.cs (6)
120internal Dictionary<string, AtsDocumentationInfo> HandleDocumentationById => _handleDocumentationById; 800AtsDocumentationInfo? documentation, 1012var documentation = _handleDocumentationById.GetValueOrDefault(builderModel.TypeId); 1097AtsDocumentationInfo? documentation, 1214var documentation = getter?.Documentation ?? setter?.Documentation; 1606private readonly Dictionary<string, AtsDocumentationInfo> _handleDocumentationById = new(StringComparer.Ordinal);
Aspire.Hosting.CodeGeneration.TypeScript.Tests (1)
AtsTypeScriptCodeGeneratorTests.cs (1)
2018AtsDocumentationInfo documentation,
Aspire.Hosting.Native.CodeGeneration (15)
src\Aspire.Hosting.RemoteHost\AtsCapabilityScanner.cs (15)
1149var typeDocumentation = GetXmlDocumentation(type); 1193var propDocumentation = GetXmlDocumentation(prop); 1743var propertyDocumentation = GetXmlDocumentation(property, memberExportAttr?.Description); 1943var methodDocumentation = GetXmlDocumentation(method, memberExportAttr?.Description); 2123var methodDocumentation = GetXmlDocumentation(method, exportAttr.Description); 2128var parameterDocumentation = GetParameterDocumentation(methodDocumentation, param.Name); 2180AtsDocumentationInfo? documentation = null) 2266var invokeDocumentation = GetXmlDocumentation(invokeMethod); 3530private static AtsDocumentationInfo? GetXmlDocumentation(MemberInfo? member, string? fallbackSummary = null) 3546private static AtsDocumentationInfo? GetXmlDocumentation(XDocument? xmlDoc, string memberName, string? fallbackSummary = null) 3549var documentation = CreateDocumentation(memberElement, fallbackSummary); 3569private static AtsDocumentationInfo? CreateDocumentation(XElement? memberElement, string? fallbackSummary) 3638private static AtsDocumentationInfo? CreateFallbackDocumentation(string? fallbackSummary) 3644private static AtsDocumentationInfo? GetParameterDocumentation(AtsDocumentationInfo? documentation, string? parameterName)
Aspire.Hosting.RemoteHost (16)
AtsCapabilityScanner.cs (15)
1149var typeDocumentation = GetXmlDocumentation(type); 1193var propDocumentation = GetXmlDocumentation(prop); 1743var propertyDocumentation = GetXmlDocumentation(property, memberExportAttr?.Description); 1943var methodDocumentation = GetXmlDocumentation(method, memberExportAttr?.Description); 2123var methodDocumentation = GetXmlDocumentation(method, exportAttr.Description); 2128var parameterDocumentation = GetParameterDocumentation(methodDocumentation, param.Name); 2180AtsDocumentationInfo? documentation = null) 2266var invokeDocumentation = GetXmlDocumentation(invokeMethod); 3530private static AtsDocumentationInfo? GetXmlDocumentation(MemberInfo? member, string? fallbackSummary = null) 3546private static AtsDocumentationInfo? GetXmlDocumentation(XDocument? xmlDoc, string memberName, string? fallbackSummary = null) 3549var documentation = CreateDocumentation(memberElement, fallbackSummary); 3569private static AtsDocumentationInfo? CreateDocumentation(XElement? memberElement, string? fallbackSummary) 3638private static AtsDocumentationInfo? CreateFallbackDocumentation(string? fallbackSummary) 3644private static AtsDocumentationInfo? GetParameterDocumentation(AtsDocumentationInfo? documentation, string? parameterName)
CodeGeneration\CodeGenerationService.cs (1)
210private static DocumentationResponse? MapDocumentation(AtsDocumentationInfo? documentation)
Aspire.TypeSystem (9)
AtsCapabilityInfo.cs (8)
232public AtsDocumentationInfo? Documentation { get; init; } 290public AtsDocumentationInfo? Documentation { get; init; } 420public AtsDocumentationInfo? Documentation { get; init; } 441public AtsDocumentationInfo? Documentation { get; init; } 498public AtsDocumentationInfo? Documentation { get; init; } 525public AtsDocumentationInfo? Documentation { get; init; } 579public AtsDocumentationInfo? Documentation { get; init; } 621public AtsDocumentationInfo? Documentation { get; init; }
AtsExportedValueInfo.cs (1)
44public AtsDocumentationInfo? Documentation { get; init; }