Documentation Archive

Developer

Markup Formatting Reference

On This Page

Single Line Comment

Add a single line of markup using these special comment markers.

Works with:

  • ✓ Playgrounds

  • ✓ Symbol documentation

Playground Syntax

Use two forward slash (/) characters followed by a colon (:) for a single line of markup for a playground.

  • //: line of markup content

Example

The followup line of markup adds a link to the next page of the playground.

  1. //: [Next Topic](@next)
image: Art/MFR_Next_page_2x.png

Quick Help Syntax

Use three forward slash (/) characters for a single line of markup Quick Help.

  • /// line of markup content

Example

The following line of markup documents a single parameter called llama.

  1. /// - parameter llamaCount: The number of llamas in the managed herd.
image: Art/MFR_symbol_section_parameter_2x.png