Add links to Swift classes in the quick help documentation comments?

Question

Assume I have two classes:

/**
  This class should be used together with [Foo]( ??? ).
*/
class Bar {
    func doNothing() {}
}

/**
  Description of what Foo does goes here.
*/
class Foo {
    func doNothing() {}
}

I want to create a link to Foo or Foo's quick help from Bar's quick help in Xcode. Is it even possible? If so, how?

The [name](target) syntax for links isn't up to snuff as far as I can tell by looking at Apple's docs and more Apple's docs.

You can achieve this by using Tags: https://stackoverflow.com/questions/38321880/how-to-go-about-adding-a-link-reference-to-another-method-in-documentation-xcode/54564301#54564301 — Pelle Stenild Coltau, Aug 30 '19 at 06:34
Does this answer your question? [Swift annotation "Tag"](https://stackoverflow.com/questions/51539020/swift-annotation-tag) — The Dreams Wind, Sep 04 '22 at 16:57

score 1 · Answer 1 · answered Oct 02 '18 at 20:55

1

I just stumbled upon this. Apparently, if the text you enclose in backticks happens to be a class, it will be rendered as a hyperlink to the class.

answered Oct 02 '18 at 20:55

edburns

482
1
4
13

I just tried this: `/** Example: "Bar()", another example: "doNothing()" */` - it only changed the font to a monospace one and didn't add a link. Edit: Stackoverflow changes the func names surrounded by backticks to code... To try it yourself, replace the four quotation marks with backticks. – Neph Jun 04 '19 at 11:44

score 1 · Answer 2 · answered Jun 23 '22 at 10:13

1

This is done using double backticks (``) around your symbols name.

This is documented in detail here: https://developer.apple.com/documentation/xcode/formatting-your-documentation-content

answered Jun 23 '22 at 10:13

Jon Cahill

4,968
4
34
31

Add links to Swift classes in the quick help documentation comments?

2 Answers2

Linked