Allow inline links to arbitrary URLs in Headerdoc text.

Originator:justatheory
Number:rdar://16745373 Date Originated:2014-04-28
Status:Open Resolved:
Product:Xcode Product Version:Xcode Version 5.1.1 (5B1008)
Classification:Enhancement Reproducible:Always
 
Summary:
I wanted to provide an inline link to a Wikipedia page in the description of an interface I was writing, but could not figure out how. I tried this:

@link http://en.wikipedia.org/wiki/Shit_or_get_off_the_pot SOGOTP @/link

But the text rendered literally. Same for @see tags.

Steps to Reproduce:
1. Create a header file with an @interface declaration.
2. Above the @interface declaration, put this text:

If you find a bug in this code, @link http://fixradarorgtfo.com Fix Radar or GTFO @/link, dude.

3. Command-click the class name to bring up the documentation popup.

Expected Results:
I expect to see the equivalent of this HTML in the rendering:

<p>If you find a bug in this code, <a href="http://fixradarorgtfo.com">Fix Radar or GTFO</a>, dude.</p>


Actual Results:
I see the equivalent of this HTML in the rendering:

<p>If you find a bug in this code,<br/>
http://fixradarorgtfo.com Fix Radar or GTFO<br/>
, dude.</p>


Version:
Xcode Version 5.1.1 (5B1008)

Notes:


Configuration:


Attachments:

Comments

David Wheeler 18-Jun-2014 06:28 PM

Hrm. I put this into some documentation: 

 * This Bloom filter implementation is a port of the Google Guava project's
 * <a href=" http://docs.guava-libraries.googlecode.com/git/javadoc/index.html?com/google/common/hash/BloomFilter.html">Java BloomFilter class</a>.

And the link appears, but the word "Java" is missing from the text!

By justatheory at June 19, 2014, 1:29 a.m. (reply...)

David Wheeler 18-Jun-2014 06:17 PM

Confirmed that an embedded HTML anchor link works in Xcode Version 6.0 (6A216f). Thanks!

By justatheory at June 19, 2014, 1:21 a.m. (reply...)

Apple Developer Relations 18-Jun-2014 01:13 PM

Engineering has provided the following information:

Per notes in Bug ID 17162693, it seems that the other issue is resolved.

Please test with Xcode 6 and update the report with your results.

Please let us know if that resolves the issue for you by updating your bug report.

By justatheory at June 19, 2014, 1:16 a.m. (reply...)

David Wheeler 04-Jun-2014 03:37 PM

Sadly, I am not yet able to run Xcode6 Beta. See rdar://17162693 for details.

By justatheory at June 4, 2014, 10:42 p.m. (reply...)

David Wheeler 28-Apr-2014 11:45 AM

Er, so…is there a replacement for headerdoc? Something else that will allow documentation to be shown in option-click popovers?

By justatheory at June 4, 2014, 10:42 p.m. (reply...)

Apple Developer Relations 03-Jun-2014 12:26 PM

Engineering has provided the following information:

Put in the documentation comment and verify with the Xcode 6 seed that documentation popup is showing the URL link.

Xcode 6 beta - Build 6A215l

Mac Developers: Use the 'OS X Yosemite Developer Preview' tab on this page: https://developer.apple.com/devcenter/mac/index.action#

iOS Developers: Use the 'iOS 8 Beta' tab on this page - https://developer.apple.com/devcenter/ios/index.action#

Please let us know if that resolves the issue for you by updating your bug report.

By justatheory at June 4, 2014, 10:41 p.m. (reply...)

Apple Developer Relations 03-Jun-2014 12:21 PM

Engineering has provided the following information:

We believe this issue has been addressed in the latest Xcode 6 beta.

This is a pre-release version of the complete Xcode developer toolset for Mac, iPhone, iPod touch, and iPad. Please review the Release Notes before installing. Xcode 6 beta requires OS X Mavericks 10.9.3 or later. Please test with this release, and update your bug report with the results.

Xcode 6 beta - Build 6A215l

Mac Developers: Use the 'OS X Yosemite Developer Preview' tab on this page: https://developer.apple.com/devcenter/mac/index.action#

iOS Developers: Use the 'iOS 8 Beta' tab on this page - https://developer.apple.com/devcenter/ios/index.action#

Please let us know if that resolves the issue for you by updating your bug report.

By justatheory at June 4, 2014, 10:41 p.m. (reply...)

Apple Developer Relations23-May-2014 09:53 AM

Engineering has determined that there are no plans to address this based on the following:

No changes/fixes planned for Headerdoc at this point.

We are now closing this bug report.

If you have questions regarding the resolution of this issue, please update your bug report with that information.

Please be sure to regularly check new Apple releases for any updates that might affect this issue.

By justatheory at June 4, 2014, 10:40 p.m. (reply...)

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!