Swift 2.0 Doc comments inconsistent styling
| Originator: | DanielMiedema | ||
| Number: | rdar://21372869 | Date Originated: | 13-Jun-2015 |
| Status: | Open | Resolved: | |
| Product: | Developer Tools | Product Version: | 2.0 |
| Classification: | Reproducible: | Always |
Summary: Swift doc comments on methods have an inconsistent styling and they don't seem to support all the previous key terms such as `discussion` and `abstract`. For example, for what was `:return:` it is `- returns: ` but for what was `:param:` it is now `- parameter ` without the `:` Steps to Reproduce: 1. Use Xcode 6 and create a Swift 1.2 project/file 2. write a method 3. Document said method with key terms for parameters, warnings, return type, etc 4. Open Xcode 7 and migrate the project to Swift 2.0 Expected Results: I would expect formatting to be consistent between the key word types & that the migrator would migrate all previous key words correctly & all previous keywords would be supported Actual Results: `discussion`, `abstract` `warning`, `note` will not migrate. Formatting style between key words is not 100% the same for all & not all previous key words are supported Version: Xcode Version 7.0 beta (7A120f) Notes: Configuration: Xcode 7 & Swift 2.0 project
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!