Markup Formatting Reference: Authors (original) (raw)

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. ``
4. - Authors:
5. Plato
6. ``
7. Aristotle
8. ``
9. Other amazing
10. classical folk
11. */

Alternative

Use the Author delimiter for a single author.

Author

Bug

Copyright © 2018 Apple Inc. All rights reserved. Terms of Use | Privacy Policy | Updated: 2017-06-05