Precondition
Adds a Precondition
callout to the Quick Help for a symbol. Multiple Precondition
callouts appear in the description section in the same order as they do in the markup.
Use the callout to document any conditions that are held for the documented symbol to work.
Works with:
Playgrounds
✓ Symbol documentation
Syntax
* | + | - Precondition: description
optional continuation of description
The description displayed in Quick Help for the precondition callout is created as described in Parameters Section.
Example
/**
An example of using the precondition field
- Precondition: The `person` property must be non-nil.
- Precondition: `updatedAddress` must be a valid address.
*/
Copyright © 2018 Apple Inc. All rights reserved. Terms of Use | Privacy Policy | Updated: 2017-06-05