Class documentation not showing up in Xcode

Question

I'm writing a UIKit library which need a lot of documentation.

I've added the documentation as regular in every library but it's not showing up within the quick help.

Example:

import UIKit

/// An extension of Apples [`UILabel`](https://developer.apple.com/documentation/uikit/uilabel).
///
/// The whole label is configurable within the storyboard builder using the`@IBInspectable`.
///
///     let myLabel = MyLabel()
///
@IBDesignable
open class MyLabel: UILabel {
}

All I get here is:

If reorder the documentation to:

/// An extension of Apples [`UILabel`](https://developer.apple.com/documentation/uikit/uilabel).
///
/// The whole label is configurable within the storyboard builder using the`@IBInspectable`.
///
///     let myLabel = MyLabel()
///

import UIKit

@IBDesignable
open class MyLabel: UILabel {
}

Or

import UIKit

@IBDesignable
/// An extension of Apples [`UILabel`](https://developer.apple.com/documentation/uikit/uilabel).
///
/// The whole label is configurable within the storyboard builder using the`@IBInspectable`.
///
///     let myLabel = MyLabel()
///
open class MyLabel: UILabel {
}

I at least I see:

But nothing of my written documentation. Method or field documentation seem to work properly.

How to I correctly write class documentation? Has this something todo with ?@IBDesignables other classes seem to work fine?

I've tried it in Xcode 9.x.x and Xcode 10.0 beta.

_{Jazzy does export everything properly.}

Herr der Töne · Accepted Answer · 2018-06-24 11:47:59Z

1

Remove the Grave accents (`) in the first line of your comment. Xcode doesn't seem to support that within links! If you remove them, your quick help will be rendered.

Instead of

/// An extension of Apples [`UILabel`](https://...)

use

/// An extension of Apples [UILabel](https://...)

edited Jun 24, 2018 at 11:47

answered Jun 24, 2018 at 11:44

Herr der Töne

18810 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

bemeyer Over a year ago

You are the man! It only doesn't render if the ` are within the link. Please edit your answer with an example which works and which not so it's more clear. Thank you very much!

Herr der Töne Over a year ago

Like it that way?

Collectives™ on Stack Overflow

Class documentation not showing up in Xcode

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related