Guides and Sample Code

Developer

Markup Formatting Reference

On This Page

Authors

Add an Authors callout with a list of authors to the Quick Help for a symbol. The order of the authors in Quick Help is the same as the order they appear in the delimiter. Multiple Authors delimiters are added to Quick Help in the order that they appear in the markup.

Use the callout to display the authors of the code for a symbol.

Works with:

  •     Playgrounds

  • ✓ Symbol documentation

Syntax

  • * | + | - Authors:
  •   author name
  •   optional continuation of author name
  •  
  •   author name
  •   optional continuation of author name
  •   …

The author names displayed in Quick Help are created as described in Returns Section.

Example

  1. /**
  2.  An example of using the authors callout
  3.  - Authors:
  4.   Plato
  5.   Aristotle
  6.   Other amazing
  7.   classical folk
  8. */
image: ../Art/MFR_symbol_field_authors_2x.png

Alternative

Use the Author delimiter for a single author.