[SR-13013] swift-format complains of missing punctuation when adding doc comments via the Xcode template

[swift-ci]

Previous ID	SR-13013
Radar	None
Original Reporter	leisurehound (JIRA User)
Type	Bug

Attachment: Download

Additional Detail from JIRA

Votes	0
Component/s	swift-format
Labels	Bug
Assignee	None
Priority	Medium

md5: 9098405131005fed6b61e5fdf05425c6

Issue Description:

When adding doc comments to a method via the Xcode shortcut, the template added is:

/// Description
/// - Parameters:
///   - param: param description

However, when entering the description and parameter description keeping the newlines as the template provides, swift format will complain about punctuation at the end of the entire doc comments, and not just the description, even if the description has punctuation.

Parameters descriptions otherwise do not seem to require punctuation.

Adding a new line between Description & - Parameters (and sometimes adding two and the deleting one is required) the swift-format punctuation concerns are alleviated.

[ahoppen]

Tracked in Apple’s issue tracker as rdar://126948260