Requires
Add a Requires callout to the Quick Help for a symbol using the Requires delimiter. See Precondition for usage.
Works with:
Playgrounds
✓ Symbol documentation
Syntax
* | + | - Requires: descriptionoptional continuation of description
The description displayed in Quick Help for the requires callout is created as described in Parameters Section.
Example
/**An example of using the requires field- Requires: `start <= end`.- Requires: `count > 0`.*/
Copyright © 2018 Apple Inc. All rights reserved. Terms of Use | Privacy Policy | Updated: 2017-06-05