Documentation Archive

Developer

Markup Formatting Reference

On This Page

Links

Add a link to a text-based resource such as a web URL or email.

Works with:

  • ✓ Playgrounds

  • ✓ Symbol documentation

Syntax

  • [text to display](URL)
  • Text to display is the text to display in the comment. It is also used for accessiblity.

  • URL is the address to open when the link in the comment is clicked.

Playground Example

  1. /*:
  2.  For more information, see [The Swift Programming Language.](http://developer.apple.com/library/ios/documentation/Swift/Conceptual/Swift_Programming_Language/)
  3. */
image: ../Art/MFR_link_eg_2x.png

Quick Help Example

  1. /**
  2.  An example of using the seealso field
  3.  - seealso:
  4.  [The Swift Standard Library Reference](https://developer.apple.com/library/prerelease/ios//documentation/General/Reference/SwiftStandardLibraryReference/index.html)
  5. */
image: ../Art/MFR_symbol_field_seealso_2x.png

See Also

Link Reference