Guides and Sample Code

Developer

Markup Formatting Reference

On This Page

Postcondition

Add a Postcondition callout to the Quick Help for a symbol using the Postcondition delimiter. Multiple Postcondition callouts appear in the description section in the same order as they do in the markup.

Use the callout to document conditions which have guaranteed values upon completion of the execution of the symbol.

Works with:

  •     Playgrounds

  • ✓ Symbol documentation

Syntax

  • * | + | - Postcondition: description
  • optional continuation of description

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

Example

  1. /**
  2.  An example of using the postcondition field
  3.  - Postcondition:
  4.  After completing this method the billing address for
  5.  the person will be set to `updatedAddress` if it is valid.
  6.  Otherwise the billing address will not be changed.
  7. */
image: ../Art/MFR_symbol_field_postcondition_2x.png