Jak dodać dokumentację do wartości powiązanych enum w Swift

Question

Czy istnieje sposób dodawania opisów do powiązanych wartości wyliczeń w Swift 3? Chcę, żeby pokazać się w dokumentacji symbolem popup (Option + kliknięcie), jak robią dla parametrów funkcyjnych w Xcode 8.

To mój enum:

enum Result { 
    /** 
    Request succeeded. 

    - Parameters: 
     - something: Some description. 
     - otherThing: Other description. 
    */ 
    case Success(something: Int, otherThing: Int) 

    /** 
    Request failed. 

    - Parameter error: Error. 
    */ 
    case Error(error: Error) 
} 

Próbowałem za pomocą - Parameters:, ale nie działa w wyliczeniach.

Answer 1

Czy to tak:

/// Enum Description 
enum Enum { 
    /// enum1 Description 
    /// - value1: value1 Description 
    /// - value2: value2 Description 
    case enum1(value1: Int, value2: String) 

    /// enum2 Description 
    case enum2 
} 

---

Pokaż wynik: