Quick Help displays HTML in Objective-C comments as plain text

Originator:mxn
Number:rdar://28628571 Date Originated:05-Oct-2016
Status:Open Resolved:
Product:Developer Tools Product Version:
Classification:Other Bug Reproducible:Always
 
Summary:
Quick Help no longer interprets HTML markup in Objective-C comments, even though Doxygen and HeaderDoc support a limited subset of HTML.

Steps to Reproduce:
1. Open the attached Objective-C file in a source editor.
2. ⌥-click a symbol such as -bold, -link, or -table to open the Quick Help popover for that symbol.

Expected Results:
Boldfaced text, a hyperlink, and a table containing monospaced text.

Actual Results:
Plain text. See the attached screenshots.

Version:
Xcode 8.0 (8A218a) and 8.1 beta 1 (8T29o)
macOS 10.11.6 (15G1004)

Notes:
Does not reproduce in Xcode versions 4.3 through 7.3.1 (7D1014).

Also does not reproduce in Swift files that use the syntax described in <https://developer.apple.com/library/content/documentation/Xcode/Reference/xcode_markup_formatting_ref/MarkupSyntax.html>.

The ability to specify HTML (or any kind of markup, really) in documentation comments is particularly important for libraries. Many libraries transform these comments into full HTML docsets using HeaderDoc, Doxygen, appledoc, or jazzy. Incidentally, jazzy has no problem with HTML markup, even though it relies on Clang for Objective-C comment parsing. So the issue definitely doesn’t lie with Clang.

Configuration:


Attachments:
successfully uploaded.

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!