Skip to content
This repository was archived by the owner on Aug 8, 2023. It is now read-only.

XCode inline documentation shows uninterpreted Markdown #3961

Closed
tmcw opened this issue Feb 15, 2016 · 1 comment
Closed

XCode inline documentation shows uninterpreted Markdown #3961

tmcw opened this issue Feb 15, 2016 · 1 comment
Labels
documentation iOS Mapbox Maps SDK for iOS

Comments

@tmcw
Copy link
Contributor

tmcw commented Feb 15, 2016

2016-02-15 at 4 08 pm

Lots of links that aren't links here. Would it be possible to remove or interpret Markdown in this view?
@tmcw tmcw added iOS Mapbox Maps SDK for iOS documentation labels Feb 15, 2016
@1ec5
Copy link
Contributor

1ec5 commented Feb 15, 2016

Quick Help is generated by Xcode (via Clang for Objective-C and SourceKit for Swift) based on the documentation comments in the header, the same headers jazzy processes.

These documentation comments were copied over from the OS X SDK and were written with appledoc’s Markdown support in mind. That was before we switched from appledoc to jazzy in #3203. I think it’s unlikely that we’ll wind up with a syntax that’s simultaneously compatible with Clang’s Doxygen/HeaderDoc, SourceKit’s reStructuredText, and jazzy’s Markdown. Perhaps we can put Doxygen syntax in the header and transform it at build time for jazzy, but I’m not sure where that leaves Swift users.

1ec5 added a commit that referenced this issue Apr 20, 2016
@1ec5
[ios, osx] Use HTML links in documentation
2d2f225 
Replaced Markdown syntax with HTML syntax for hyperlinks in documentation comments. HTML links work both inside Xcode (whether Objective-C or Swift) and on the Web (via jazzy).

Fixes #3961.
@1ec5 1ec5 mentioned this issue Apr 20, 2016
Merged
1ec5 added a commit that referenced this issue Apr 20, 2016
@1ec5
[ios, osx] Use HTML links in documentation
de0705c 
Replaced Markdown syntax with HTML syntax for hyperlinks in documentation comments. HTML links work both inside Xcode (whether Objective-C or Swift) and on the Web (via jazzy).

Fixes #3961.
friedbunny pushed a commit that referenced this issue Apr 20, 2016
@1ec5 @friedbunny
[ios, osx] Use HTML links in documentation
d07e5b5 
Replaced Markdown syntax with HTML syntax for hyperlinks in documentation comments. HTML links work both inside Xcode (whether Objective-C or Swift) and on the Web (via jazzy).

Fixes #3961.

Cherry-picked from de0705c.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation iOS Mapbox Maps SDK for iOS
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tmcw @1ec5