jazzy icon indicating copy to clipboard operation
jazzy copied to clipboard

Soulful docs for Swift & Objective-C

Results 109 jazzy issues
Sort by recently updated
recently updated
newest added

Hello @johnfairh I don't need to install manually in terminal the jazzy. I need a Run-Script like, Script needs to take-care after adding in build phases. Thanks In Advance😊.

help

When using Jazzy with the following xcodebuild-arguments `jazzy -x -scheme,TestScheme,-configuration,TestSim,-destination,'platform=iOS Simulator,name=iPhone 6,OS=10.0'` The issue is that the -destination flag is parsed as 'platform:iOS Simulator' and the rest of the destination...

documentation

Example: ``` NS_ASSUME_NONNULL_BEGIN typedef void(^SomeCompletion)(NSString * _Nullable str); @interface SomeClass: NSObject - (void)loadTokenWithCompletionHandler:(SomeCompletion)completionHandler; @end NS_ASSUME_NONNULL_END ``` Generated swift file: ``` public typealias SomeCompletion = (String?) -> Void open class SomeClass...

bug
sourcekitten

Sometimes we need a proper test report (looking at you, ISO-900x!) which (afaik) XCode can't/won't generate for us. Jazzy could, when building documentation for test modules (cf #504), run the...

I have the following enum: ``` /// The aspect ratio of the image. /// /// - wide: 16:9 aspect ratio. /// - standard: 4:3 aspect ratio. public enum AspectRatio {...

bug

front-end
ruby
priority-low
difficulty-easy

front-end
priority-low
difficulty-easy

The README is very light on usage information and how jazzy parses documentation. Does it parse Markdown? reST? Which tokens does it support (in addition to `:param:`, `:returns:`)?

project
priority-low
difficulty-easy

front-end
priority-low
difficulty-moderate

I'm looking into using Jazzy to document an app, and it sure would be nice to split the lefthand menu into logical groups like the folder structure of the app....

help-wanted
front-end
feature
priority-low