Markup Formatting Reference: Invariant (original) (raw)

Add an Invariant callout to the description of a symbol using the Invariant delimiter. Multiple Invariant callouts appear in the description section in the same order as they do in the markup.

Use the callout to display a condition that is guaranteed to be true during the execution of the documented symbol.

Works with:

• Playgrounds
• ✓ Symbol documentation

Syntax

• • | + | - Invariant: description
• optional continuation of description

The description displayed in Quick Help for the invariant callout is created as described in Parameters Section.

Example

1. /**
2. An example of using the invariant field
3. ``
4. - Invariant:
5. The person reference will not change during the execution of this method
6. */

Important

Localization Key

Copyright © 2018 Apple Inc. All rights reserved. Terms of Use | Privacy Policy | Updated: 2017-06-05