From 867043eb262b6553cf1920e64b16c8ba7eb871be Mon Sep 17 00:00:00 2001 From: Mattt Date: Fri, 31 Jul 2020 13:08:53 -0700 Subject: [PATCH 1/3] Remove extra tag --- .../swift-doc/Supporting Types/Components/Documentation.swift | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Sources/swift-doc/Supporting Types/Components/Documentation.swift b/Sources/swift-doc/Supporting Types/Components/Documentation.swift index ae533dd2..3792bfe4 100644 --- a/Sources/swift-doc/Supporting Types/Components/Documentation.swift +++ b/Sources/swift-doc/Supporting Types/Components/Documentation.swift @@ -145,7 +145,7 @@ struct Documentation: Component { return #""" \#(softbreak(entry.name)) - \#(typeCell) + \#(typeCell) \#(commonmark: entry.description) """# as HypertextLiteral.HTML From 87ac96149d54a97ddabec7be1782c243afb3a839 Mon Sep 17 00:00:00 2001 From: Mattt Date: Fri, 31 Jul 2020 13:13:07 -0700 Subject: [PATCH 2/3] Render parameter documentation content instead of description --- .../swift-doc/Supporting Types/Components/Documentation.swift | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Sources/swift-doc/Supporting Types/Components/Documentation.swift b/Sources/swift-doc/Supporting Types/Components/Documentation.swift index 3792bfe4..f1324288 100644 --- a/Sources/swift-doc/Supporting Types/Components/Documentation.swift +++ b/Sources/swift-doc/Supporting Types/Components/Documentation.swift @@ -119,7 +119,7 @@ struct Documentation: Component { type = nil } - return (entry.name, type, entry.description) + return (entry.name, type, entry.content) } fragments.append(#""" From 0b3f0458d777d52dffc58aa1a5e8e30a7447aa41 Mon Sep 17 00:00:00 2001 From: Mattt Date: Fri, 31 Jul 2020 13:14:38 -0700 Subject: [PATCH 3/3] Add changelog entry for #156 --- Changelog.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Changelog.md b/Changelog.md index 33b2e473..5eab7a5d 100644 --- a/Changelog.md +++ b/Changelog.md @@ -43,6 +43,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Fixed regression that caused nodes in relationships graph to not have links to their corresponding symbol documentation. #153 by @mattt. +- Fixed markup for parameter descriptions in HTML output. + #156 by @mattt. ## [1.0.0-beta.3] - 2020-05-19