Guides and Sample Code

Developer

Markup Formatting Reference

On This Page

Author

Add an Author callout with a single name to the Quick Help for a symbol using the Author delimiter. Multiple Author callouts appear in the description section in the same order as they do in the markup

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

Works with:

  •     Playgrounds

  • ✓ Symbol documentation

Syntax

  • * | + | - Author: author name
  • optional continuation of author name

The author name displayed in Quick Help is created as described in Parameters Section.

Example

  1. /**
  2.  An example of using the author field
  3.  - Author: William Shakespeare
  4. */
image: ../Art/MFR_symbol_field_author_2x.png

Alternative

Use the Authors delimiter to list multiple authors in one callout.