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