https://go-openapi.github.io/codescan/shaping-the-output/titles-and-descriptions/index.htmlShape the human-readable text — override godoc with API-facing title and description, route single-line comments to the description, keep annotations out of the godoc, and clean godoc doc-links out of generated prose.Hugoen-ushttps://go-openapi.github.io/codescan/shaping-the-output/titles-and-descriptions/overriding-titles-and-descriptions/index.htmlMon, 01 Jan 0001 00:00:00 +0000https://go-openapi.github.io/codescan/shaping-the-output/titles-and-descriptions/overriding-titles-and-descriptions/index.htmlReplace the godoc-derived title and description with API-facing text using swagger:title and swagger:description — on models, fields, $ref'd fields and responses.https://go-openapi.github.io/codescan/shaping-the-output/titles-and-descriptions/markdown-descriptions/index.htmlMon, 01 Jan 0001 00:00:00 +0000https://go-openapi.github.io/codescan/shaping-the-output/titles-and-descriptions/markdown-descriptions/index.htmlCarry a verbatim markdown body — tables, blank lines, indentation and all — into a description with the swagger:description | literal block-scalar marker, instead of letting Option B fold it.https://go-openapi.github.io/codescan/shaping-the-output/titles-and-descriptions/single-line-comments/index.htmlMon, 01 Jan 0001 00:00:00 +0000https://go-openapi.github.io/codescan/shaping-the-output/titles-and-descriptions/single-line-comments/index.htmlRoute every single-line doc comment to description instead of title/summary with the SingleLineCommentAsDescription option.https://go-openapi.github.io/codescan/shaping-the-output/titles-and-descriptions/keeping-annotations-out-of-the-godoc/index.htmlMon, 01 Jan 0001 00:00:00 +0000https://go-openapi.github.io/codescan/shaping-the-output/titles-and-descriptions/keeping-annotations-out-of-the-godoc/index.htmlLet swagger annotations live inside a struct body or as trailing comments so the godoc above each declaration stays clean — the AfterDeclComments opt-in.https://go-openapi.github.io/codescan/shaping-the-output/titles-and-descriptions/cleaning-godoc-doc-links/index.htmlMon, 01 Jan 0001 00:00:00 +0000https://go-openapi.github.io/codescan/shaping-the-output/titles-and-descriptions/cleaning-godoc-doc-links/index.htmlStrip godoc doc-link brackets from generated descriptions and recompose resolvable links to each schema's exposed name — the CleanGoDoc opt-in.