Warning
Add a Warning
callout to the Quick Help for a symbol using the Warning delimiter. Multiple Warning
callouts appear in the description section in the same order as they do in the markup.
Works with:
Playgrounds
✓ Symbol documentation
Syntax
* | + | - Warning: description
optional continuation of description
The description displayed in Quick Help for the warning callout is created as described in Parameters Section.
Example
/**
An example of using the warning field
- Warning:
Not all code paths for this method have been tested
*/
Copyright © 2018 Apple Inc. All rights reserved. Terms of Use | Privacy Policy | Updated: 2017-06-05