Parameter
Add the name and description for a single parameter to the Parameters
section of Quick Help. The parameters are added to Quick Help in the order that they appear in the markup.
The Parameters
section is only added to Quick Help if there is at least one Parameters or Parameter delimiter in the markup for a symbol. The section contains entries for all the Parameters delimiters followed by entries for all the Parameter delimiters.
Works with:
Playgrounds
✓ Symbol documentation
Syntax
* | + | - Parameter parameter name: description
optional continuation of description
optional paragraph
…
Add paragraphs to the description of a symbol by adding an empty line and indenting the text for the paragraph by a tab or by four spaces.
The description displayed in Quick Help for the parameter is created as described in Parameters Section.
Example
/// - Parameter llamaCount: The number of llamas in the managed herd.
Alternative
Use the Parameters delimiter to add multiple parameters.
Copyright © 2018 Apple Inc. All rights reserved. Terms of Use | Privacy Policy | Updated: 2017-06-05