Issue with `docComments` rule: converts /// to //

[MaxenceMottard]

Summary

When running SwiftFormat 0.58.7 with the docComments rule enabled, many /// doc comments are converted into // line comments. This breaks DocC/public symbol documentation.

Environment

• SwiftFormat version: 0.58.7
• Swift version: 5.7 (configured)
• Command: swiftformat . --config .config/.swiftformat

Config

Relevant excerpt from .swiftformat:

--disable all
--enable ...
--enable docComments
--header strip

(full config available if needed)

Reproduction

1. Create a Swift file like this:

/// Protocol for providing authentication challenges.
public protocol ChallengeProvider {
    func refreshChallenge()
}

2. Run SwiftFormat 0.58.7 with the docComments rule enabled.

Actual result

The /// comment becomes:

// Protocol for providing authentication challenges.
public protocol ChallengeProvider {
    func refreshChallenge()
}

Expected result

/// doc comments should be preserved (or at least not downgraded to //).

Notes

This happens across multiple files in our codebase once the rule is enabled. We’ve disabled the rule temporarily as a workaround.

[calda]

I can't reproduce with this config file:

--disable all
--enable docComments
--header strip

or:

--disable all
--enable docComments
--enable fileHeader
--header strip
--swift-version 5.7

This Swift file is preserved as-is as expected:

/// Protocol for providing authentication challenges.
public protocol ChallengeProvider {
    func refreshChallenge()
}

[calda]

Can you share a full Swift file that demonstrates the issue?

[MaxenceMottard]

Yes sure, I've created a little repository with some sample files and a configuration where you can reproduce the bug:
https://github.com/MaxenceMottard/swiftformat-doc-comments-issues

[calda]

Thanks, here's a fix: #2314