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

check out Jazzy for Swift-compatible iOS docs #1420

Closed
incanus opened this issue May 5, 2015 · 2 comments
Closed

check out Jazzy for Swift-compatible iOS docs #1420

incanus opened this issue May 5, 2015 · 2 comments
Assignees
@1ec5
Labels
build documentation iOS Mapbox Maps SDK for iOS

Comments

@incanus
Copy link
Contributor

incanus commented May 5, 2015

Been meaning to check out Jazzy anyway, but now CocoaPods supports it.
@incanus incanus added iOS Mapbox Maps SDK for iOS build labels May 5, 2015
@incanus incanus added this to the iOS Beta 2 milestone May 5, 2015
@1ec5
Copy link
Contributor

1ec5 commented May 5, 2015

Jazzy is built atop Clang and the Swift compiler, so it’ll expect Doxygen or HeaderDoc for Objective-C and reStructuredText for Swift, rather than the AppleDoc format we’ve been using.

@incanus incanus removed this from the iOS Beta 2 milestone Jun 1, 2015
1ec5 added a commit that referenced this issue Dec 6, 2015
@1ec5
[ios] Generate API documentation using jazzy
ca924b0 
Replaced appledoc usage with jazzy, which understands modern Objective-C syntax by virtue of using Clang ASTs. Nevertheless, we have to make lots of changes to our documentation syntax, which was tailored to appledocs quirks. The new syntax jives much better with what Xcode expects in terms of auto-indentation and Quick Help.

Fixes #1420.
@1ec5 1ec5 mentioned this issue Dec 6, 2015
Merged
@1ec5 1ec5 self-assigned this Dec 6, 2015
@1ec5
Copy link
Contributor

1ec5 commented Dec 6, 2015

Implemented in #3203.

1ec5 added a commit that referenced this issue Dec 14, 2015
@1ec5
[ios] Generate API documentation using jazzy
c05daaf 
Replaced appledoc usage with jazzy, which understands modern Objective-C syntax by virtue of using Clang ASTs. Nevertheless, we have to make lots of changes to our documentation syntax, which was tailored to appledocs quirks. The new syntax jives much better with what Xcode expects in terms of auto-indentation and Quick Help.

Fixes #1420.
1ec5 added a commit that referenced this issue Dec 21, 2015
@1ec5
[ios] Generate API documentation using jazzy
4abd3db 
Replaced appledoc usage with jazzy, which understands modern Objective-C syntax by virtue of using Clang ASTs. Nevertheless, we have to make lots of changes to our documentation syntax, which was tailored to appledocs quirks. The new syntax jives much better with what Xcode expects in terms of auto-indentation and Quick Help.

Fixes #1420.
1ec5 added a commit that referenced this issue Dec 23, 2015
@1ec5
[ios] Generate API documentation using jazzy
eb8b80d 
Replaced appledoc usage with jazzy, which understands modern Objective-C syntax by virtue of using Clang ASTs. Nevertheless, we have to make lots of changes to our documentation syntax, which was tailored to appledocs quirks. The new syntax jives much better with what Xcode expects in terms of auto-indentation and Quick Help.

Fixes #1420.
1ec5 added a commit that referenced this issue Jan 5, 2016
@1ec5
[ios] Generate API documentation using jazzy
1420a49 
Replaced appledoc usage with jazzy, which understands modern Objective-C syntax by virtue of using Clang ASTs. Nevertheless, we have to make lots of changes to our documentation syntax, which was tailored to appledocs quirks. The new syntax jives much better with what Xcode expects in terms of auto-indentation and Quick Help.

Fixes #1420.
@1ec5 1ec5 closed this as completed in #3203 Jan 5, 2016
@1ec5 1ec5 removed the in progress label Jan 5, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@1ec5 1ec5

Labels
build documentation iOS Mapbox Maps SDK for iOS
Projects
None yet
Milestone
No milestone
Development

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