Add support for relative links to Xcode Swift documentation comments

Originator:davbeck
Number:rdar://24742580 Date Originated:19-Feb-2016 09:27 AM
Status:Open Resolved:
Product:Developer Tools Product Version:Swift 2.2
Classification:Enhancement Reproducible:Always
 
Summary:
Swift has excellent documentation comment support and Xcode displays them beautifully in things like the quick documentation popover. While you can link to websites, and embed images from the web, it would be very useful to be able to link to things in the same project like Github does with it’s README markdown files (https://github.com/blog/1395-relative-links-in-markup-files).

In particular, I use Facebook’s snapshotting tools in my unit tests, and would love to be able to link to those snapshots in the documentation for the views.

Comments


Please note: Reports posted here will not necessarily be seen by Apple. All problems should be submitted at bugreport.apple.com before they are posted here. Please only post information for Radars that you have filed yourself, and please do not include Apple confidential information in your posts. Thank you!