The Xcode documenter documents anything that starts with "case" in an enum
Originator: | SaagarJha28 | ||
Number: | rdar://31828599 | Date Originated: | 25-Apr-2017 08:24 PM |
Status: | Duplicate/26613679 | Resolved: | |
Product: | Developer Tools | Product Version: | Xcode Version 8.3.2 (8E2002)/macOS Sierra 10.12.5 Beta (16F67a) |
Classification: | UI/Usability | Reproducible: |
Summary: The Xcode built in documenter seems to have a bug in which it documents anything starting with "case" in an enum (see attached project). While this may seem like correct behavior at first glance, this breaks down when a switch is used inside a method in the enum, since the documenter will treat these cases as cases of the outer enum when creating comments. Steps to Reproduce: 1. Download the sample code 2. Open main.swift 3. Follow the steps (run the documenter on the enum) Expected Results: The documenter only documents enum cases Actual Results: The documenter documents anything that starts with "case" Version: Xcode Version 8.3.2 (8E2002)/macOS Sierra 10.12.5 Beta (16F67a) Notes: Configuration: Early 2015 MacBook Pro with Retina Display running macOS Sierra 10.12.5 Beta (16F67a)
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!