Guides and Sample Code

Developer

Markup Formatting Reference

On This Page

Throws

Add the Throws section to Quick Help for a symbol using the Throws delimiter. Use the throws section to specify any errors thrown by a method or function

Works with:

  •     Playgrounds

  • ✓ Symbol documentation

Syntax

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

The description displayed in Quick Help for the throws section is created as described in Parameters Section.

Example

  1. /// - throws: An error of type `FakeArrayError`
image: ../Art/MFR_symbol_section_throws_2x.png