Swift 3 error: "See also" callout not showing

Question

I just migrated my project to Swift 3 and found that the "See also" callout in the quick help is not showing. Everything was perfectly working in the previous version of Swift. Below is my code:

/**
 Adds a "See also" callout in the Quick Help for a symbol using the `seealso` delimiter. Multiple "See also" callouts appear in the description section in the same order as they do in the markup.

 - author: Tapas Pal

 - remark: Use the callout to add references to other information.

 - seealso: [The Swift Standard Library Reference](https://developer.apple.com/library/prerelease/ios//documentation/General/Reference/SwiftStandardLibraryReference/index.html)
*/
class SeeAlsoMarkup: NSObject {
    static func doSomething() {}
}

The output is as follows:

Did Apple change anything with this markup? Apple's See Also markup formatting reference is still showing seealso as a valid callout.

Seems like a bug, it doesn't display for me and it's been a while since this post. My solution for now is to use something like `**See also:** TextField` — HotFudgeSunday, Feb 22 '17 at 19:33
@Jevon718 What Xcode version (build) you using? Still not working for me. — nemissm, Mar 23 '18 at 02:11
I'm using Xcode 9.2; neither `- seealso:`, `- seeAlso:` nor `- SeeAlso:` works on option-click. All are highlighted in code as "Documentation Markup Keywords" though. — Nicolas Miari, Jul 18 '18 at 09:02
`- returns:` for the method's return value doesn't seem to work either (it **is** highlighted as documentation comment keyword in the editor though). — Nicolas Miari, Dec 26 '18 at 09:38
This is still an issue in Xcode 10.1, all `- seealso:`, `- seeAlso:`, `- SeeAlso:` gets **highlighted** in the comment, but neither works as documentation (when alt-clicking) — Sajjon, Mar 11 '19 at 12:25
This is still an issue in Xcode 10.2.1 (haven't updated to 11 yet): `- SeeAlso` (and its variations) is written in bold letters in the code but doesn't show up in the documentation popup. @NicolasMiari Try an uppercase `- Returns:`. — Neph, Jun 13 '19 at 14:34
And same in 14.x. It seems this feature has a lot of issues since its first introduction, until now. I hope someone at Apple takes some responsibility. Honestly, it's a cool feature, it just never worked flawlessly. ;) — CouchDeveloper, Nov 20 '22 at 13:18

score 8 · Answer 1 · answered Apr 07 '20 at 16:54

(XCode 11, Swift 5)

For clarification on this question, it appears that XCode recognizes markdown in documentation comments. If you have something like:

/// # Reference 
/// [Link to Reference](https://www.google.com)

It gets recorded as:

I don't know that this hooks into the documentation keywords in the same way that @seealso does, because the # markdown tag just refers to a header style. To demonstrate this point, you can add arbitrary sections to your documentation using the # tag:

///  # Reference
///  [Link to Reference](https://www.google.com)
///  # Section
///  This is a new section of documentation
///  # Remark
///  New remark

Gets recorded as:

score 6 · Answer 2 · edited Feb 14 '22 at 11:46

6

Replace seealso with # Reference.

edited Feb 14 '22 at 11:46

Adil Hussain

30,049
21
112
147

answered Aug 01 '17 at 09:34

Ajay Singh Mehra

1,313
9
19

1

@Sajjon instead of `- SeeAlso: [Title](link)` use `# Reference \n [Title](link)` – farzadshbfn Jun 13 '19 at 15:37
2

With # Reference, Xcode doesn't show the included link – Igor Kovryzhkin Feb 18 '20 at 13:04
@KIO, it does, but only if you have a newline after `Reference`. – NRitH Jun 15 '20 at 15:57

Swift 3 error: "See also" callout not showing

2 Answers2

Linked