Header docs have more than Xcode doc viewer - a bug?

Question

Created Jan ’20

Replies 2

Boosts 0

Participants 2

As an example, I wanted to know how to init a `Slider`. I know two ways of finding documentation, but they give different results. Is that a bug?

1. Go to Xcode's Help menu > Developer Documentation, and search for "Slider". The docs for `init` do not describe the parameters.

2. Control click on `Slider` in the code editor window, then "Jump to Definition", and I see the `Slider` struct and some extensions. There *are* documentation comments describing the parameters to `init`, like the `onEditingChanged` parameter.

(Xcode version 11.3.1 (11C504))

Boost

Answer 1

Claude31 OP

Jan ’20

I do not understand your point.

Here is what I get:

with first method (extract)

Generic StructureSlider

A control for selecting a value from a bounded linear range of values.

Declaration

struct Slider<Label, ValueLabel> where Label : View, ValueLabel : View

Overview

The appearance and interaction of

Slider

is determined at runtime and can be customized.

Slider

uses the

SliderStyle

provided by its environment to define its appearance and interaction. Each platform provides a default style that reflects the platform style, but providing a new style will redefine all

Slider

instances within that environment.

Topics

Creating a Slider

init<V>(value: Binding<V>, in: ClosedRange<V>, onEditingChanged: (Bool) -> Void)

Available when

Label

is

EmptyView

and

ValueLabel

is

EmptyView

.

init<V>(value: Binding<V>, in: ClosedRange<V>, onEditingChanged: (Bool) -> Void, label: () -> Label)

Available when

ValueLabel

is

EmptyView

.

with second method:

public struct Slider<Label, ValueLabel> : View where Label : View, ValueLabel : View {

/// Declares the content and behavior of this view.

public var body: some View { get }

/// The type of view representing the body of this view.

///

/// When you create a custom view, Swift infers this type from your

/// implementation of the required `body` property.

public typealias Body = some View

}

0

Answer 2

rnikander OP

Jan ’20

If you click on one of those initializers, the Xcode documentation browser shows no documentation - just the method signature. But the second way, the generated header on whatever it's called, you can scroll down and see more helpful documentation for the parameters to `init`, like this:

extension Slider {


    /// Creates an instance that selects a value from within a range.
    ///
    /// - Parameters:
    ///     - value: The selected value within `bounds`.
    ///     - bounds: The range of the valid values. Defaults to `0...1`.
    ///     - onEditingChanged: A callback for when editing begins and ends.
    ///     - minimumValueLabel: A `View` that describes `bounds.lowerBound`.
    ///     - maximumValueLabel: A `View` that describes `bounds.lowerBound`.
    ///     - label: A `View` that describes the purpose of the instance.
    ///
    /// The `value` of the created instance will be equal to the position of
    /// the given value within `bounds`, mapped into `0...1`.
    ///
    /// `onEditingChanged` will be called when editing begins and ends. For
    /// example, on iOS, a `Slider` is considered to be actively editing while
    /// the user is touching the knob and sliding it around the track.
    public init(value: Binding, .......

0