Swift comment documentation doesn't format properly if indented with tabs
| Originator: | preble | ||
| Number: | rdar://22949357 | Date Originated: | 2015/10/2 |
| Status: | Duplicate/22209582 | Resolved: | |
| Product: | Xcode | Product Version: | 7.0, 7.1 |
| Classification: | Other Bug | Reproducible: | Always |
Summary:
When documenting an indented Swift function or property with /** */, if it is indented with tabs the body of the comment will be interpreted as if it were intended within the comment, not markdown. When indented with spaces it is correctly interpreted.
Steps to Reproduce:
Create a simple data structure with a property and document it, indenting with tabs (this text is indented with spaces):
struct SomeStruct {
/**
Some text about `someProperty`.
*/
var someProperty: AnyObject
}
Expected Results:
Option-clicking on someProperty shows the correct markdown-formatted documentation.
Actual Results:
The documentation is shown as preformatted text in a darkened box, as if it were indented within the comment. If the same comment text is indented with spaces, it is correctly formatted using markdown.
Version:
Version 7.0.1 (7A1001)
Version 7.1 beta (7B60)
Notes:
Configuration:
Happens in all known Xcode 7 versions.
Comments
Please note: Reports posted here will not necessarily be seen by Apple. All problems should be submitted at bugreport.apple.com before they are posted here. Please only post information for Radars that you have filed yourself, and please do not include Apple confidential information in your posts. Thank you!