Images in documentation comments not working?

Question

rnikander OP

Created Mar ’20

Replies 3

Boosts 0

Views 1.8k

Participants 3

Does anyone use this? I can't get it working. I'm talking about code in normal swift files, not playgrounds.

Example:

/// ![testdiagram](/Users/me/fullpathto/test-image.png)
/// ![test xcode image](http://devimages.apple.com.edgekey.net/assets/elements/icons/128x128/xcode.png)
///

Neither one displays anything in the documentation popover or the Quick Help Inspector.

The docs act like it works: https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_markup_formatting_ref/Images.html#//apple_ref/doc/uid/TP40016497-CH17-SW1

A lot of my code would really benefit from diagrams in documentation. I'd love to be able to use this.

Boost

Answer 1

rnikander OP

Mar ’20

This post was delayed by moderation, but in that time someone answered on the Swift forums. Apparently it's a known bug.

0

Answer 2

jm_kayak OP

Jul ’20

Can I track this bug somewhere?

0

Answer 3

clayellis OP

Oct ’22

For reference, the Swift forums comment mentioned above is here.

The comment (by Kyle Murray — krilnon on Swift forums) is:

This is a known issue (rdar://39360782). I narrowly missed the window of opportunity to update the markup reference before it became part of the archived documentation.

Are there any Apple engineers willing to pick this one up? It would be an extremely helpful tool, especially with the renewed push for good documentation à la DocC.

0