search

swiftlang / swift-format

Formatting technology for Swift source code
Apache License 2.0
2.46k stars 225 forks source link

[SR-13014] swift-format does not interpret parameter doc comments when Parameters is not capitalized, but Xcode jump quick help is parsed correctly. #320

Open swift-ci opened 4 years ago

swift-ci commented 4 years ago
Previous ID SR-13014
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: 52a4e4911c825ed252a498da0d83caf6

Issue Description:

When the 'parameter' text in a doc comment is not capitalized, swift-format alerts that not all parameters are documented. however, the xcode quick help parses the doc comment and displays the quick help appropriately

swift-ci commented 4 years ago

Comment by Tim Wise (JIRA)

I think this also applies to the Returns label.

ahoppen commented 4 months ago

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