Guides and Sample Code

Developer

Markup Formatting Reference

On This Page

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

  1. /**
  2.  An example of using the warning field
  3.  - Warning:
  4.  Not all code paths for this method have been tested
  5. */
image: ../Art/MFR_symbol_field_warning_2x.png