Как документировать регистр перечисления с параметрами?

Question

Учитывая enum это имеет case с параметрами, как я могу документировать эти параметры?

Например, эти комментарии к коду:

/// Various coffee types.
enum Coffee {

  /// A Cappuccino.
  /// - parameters:
  ///   - cream: Is true if cream is added.
  case cappuccino(cream: Bool)
}

произвести это всплывающее окно, в котором отсутствует cream документация по параметрам.

Итак, какова правильная разметка?

Answer 1

/// Various coffee types.
enum Coffee {

    /// A Cappuccino.
    /// - cream: Is true if cream is added.
    case cappuccino(cream: Bool)
}

Это будет отображаться в качестве маркера при нажатии на cappuccino но не появится, если вы нажмете на cream параметр.. Но это достаточно хорошо, я думаю..