Guides and Sample Code

Developer

Markup Formatting Reference

On This Page

Bug

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

Use the callout to display a bug for a symbol.

Works with:

  •     Playgrounds

  • ✓ Symbol documentation

Syntax

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

The description displayed in quick for the help bug callout is created as described in Parameters Section.

Example

  1. /**
  2.  An example of using the bug field
  3.  - Bug:
  4.  [*bugExample* contains a memory leak](BugDB://problem/1367823)
  5.  - Bug:
  6.  [Passing a `UIViewController` crashes *bugExample*](BugDB://problem/2274610)
  7. */
image: ../Art/MFR_symbol_field_bug_2x.png