Guides and Sample Code

Developer

Markup Formatting Reference

On This Page

To Do

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

Use the callout to add tasks required to complete or update the functionality of the symbol.

Works with:

  •    Playgrounds

  • ✓ Symbol documentation

Syntax

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

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

Example

  1. /**
  2.  An example of using the ToDo field
  3.  - ToDo: Run code coverage and add tests
  4. */
image: ../Art/MFR_symbol_field_todo_2x.png