30 writes to Summary
Aspire.Hosting.CodeGeneration.Go (10)
AtsGoCodeGenerator.cs (10)
705Summary = capability.Documentation?.Summary,
750Summary = enumType.Documentation?.Summary,
767Summary = memberDocumentation?.Summary,
807Summary = dto.Documentation?.Summary ?? dto.Description,
834Summary = property.Documentation?.Summary ?? property.Description,
913Summary = valueInfo.Documentation?.Summary ?? valueInfo.Description,
1116Summary = documentation?.Summary,
1268Summary = documentation?.Summary,
1353return _docs.Render(new GoDocContent { GoName = goName, Summary = summary });
2147Summary = capability.CapabilityKind == AtsCapabilityKind.PropertySetter ? null : p.Documentation?.Summary,
Aspire.Hosting.CodeGeneration.Go.Tests (20)
GoDocCommentTests.cs (20)
53("method summary is reworded to start with the name", new GoDocContent { GoName = "AddRedis", Summary = "Adds a Redis container resource." }),
54("summary that already starts with the name is kept", new GoDocContent { GoName = "AddRedis", Summary = "AddRedis adds a Redis container resource." }),
55("getter", new GoDocContent { GoName = "DisplayName", Subject = GoDocSubject.Getter, Summary = "Gets or sets the display name." }),
56("setter", new GoDocContent { GoName = "SetDisplayName", Subject = GoDocSubject.Setter, Summary = "Gets or sets the display name." }),
57("boolean getter", new GoDocContent { GoName = "IsEnabled", Subject = GoDocSubject.Getter, Summary = "Gets or sets a value indicating whether the resource is enabled." }),
58("setter falls back to the description when the property text cannot be reworded", new GoDocContent { GoName = "SetPort", Subject = GoDocSubject.Setter, Summary = "The port.", FallbackSummary = "Sets the Port property" }),
59("field with a noun phrase", new GoDocContent { GoName = "Port", Subject = GoDocSubject.Field, Summary = "The port to listen on." }),
60("field with a sentence", new GoDocContent { GoName = "Pending", Subject = GoDocSubject.Field, Summary = "The resource is pending." }),
61("field with whether", new GoDocContent { GoName = "UseTls", Subject = GoDocSubject.Field, Summary = "Whether TLS is used." }),
62("type without a verb", new GoDocContent { GoName = "Settings", Subject = GoDocSubject.Type, Summary = "Test settings." }),
68Summary = "Adds documentation.",
74("experimental", new GoDocContent { GoName = "WithPreview", Summary = "Adds a preview.", IsExperimental = true }),
75("obsolete with a message", new GoDocContent { GoName = "WithLegacy", Summary = "Adds the legacy behavior.", IsObsolete = true, ObsoleteMessage = "Use WithPreview instead.\nIt replaces this method." }),
76("obsolete without a message", new GoDocContent { GoName = "WithLegacy", Summary = "Adds the legacy behavior.", IsObsolete = true }),
77("experimental and obsolete", new GoDocContent { GoName = "WithLegacy", Summary = "Adds the legacy behavior.", IsExperimental = true, IsObsolete = true, ObsoleteMessage = "Use WithPreview." }),
81Summary = "Adds a resource whose documentation is long enough that it has to wrap across several comment lines - the next dash must not start a list item - or a heading # either.",
84("a remark that looks like a heading stays a paragraph", new GoDocContent { GoName = "WithHeading", Summary = "Adds a heading.", Remarks = "Overview\n- first item" }),
85("special characters are kept", new GoDocContent { GoName = "WithSpecialCharacters", Summary = "Adds <special> characters & \"quotes\", a backslash \\ and a */ terminator. Unicode: 你好こんにちは." }),
104Summary = text,
128Summary = "Adds a thing.",
3 references to Summary
Aspire.Hosting.CodeGeneration.Go (3)