How to document argument label and not parameter name of Swift function in XCode?

Question

I know how to document the parameter name of a function like:

/**
 - parameters:
   - param: the parameter
 */
func myFunc(param: Int) {...}

but I am unable to document the argument label (either with or without the parameter name):

/**
 - parameters:
   - label: the label
   - param: the parameter
 */
func myFunc(label param: Int) {...}

After all, documenting the label is more important than the parameter name, as it is what is used at function calls.

Note: I've been unable to find the trick in Apple's documentation, or I did I miss something?

user3151675 · Accepted Answer · 2018-03-13 23:00:16Z

1

You cannot directly refer to the argument label in the documentation of a function.

As a workaround, you can mention the label in the description of the parameter, like this:

/**
 - parameters:
     - param: (argument label: `label`) the parameter
 */
func myFunc(label param: Int) {...}

With the usage of back-ticks, it blends in nicely with the parameter itself:

answered Mar 13, 2018 at 23:00

user3151675

58.4k29 gold badges186 silver badges240 bronze badges

Sign up to request clarification or add additional context in comments.

1 Answer 1