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

Love that jazzy now supports Obj-C doc generation. Would be awesome to have support for projects/frameworks that depend on other frameworks. E.g. Parse depending on Bolts.framework Or even Parse +...

sourcekitten
priority-high
difficulty-moderate

(GitHub) Markdown supports checkboxes: ```markdown - [ ] unchecked checkbox - [x] checked checkbox ``` - [ ] unchecked checkbox - [x] checked checkbox As far as I can see,...

enhancement

Thanks!

enhancement

https://github.com/realm/jazzy/issues/843 covered parsing the `message` parameter of the [`deprecated`](http://clang.llvm.org/docs/AttributeReference.html#deprecated) `__attribute__`, but clang/Xcode also support a second argument named `replacement`, which takes a method/property signature and prompts the developer via fix-it...

enhancement
sourcekitten

When enter text to search, a list of suggestions appear, but I notice that the text is actually going off the browser along with the container. Actually you can swipe...

bug
front-end

How is it about integrating plantUML to easily support UML diagrams in markdown sections?

enhancement

I have still some instance variables in the headers in some classes. That should not show up in the doc.

enhancement

**Edit:** As of 0.8.3 Documentation for symbols in `#if` statements is no longer lost, but: 1. The declaration section for such symbols is unpredictable. Sometimes the declaration is lost completely,...

bug
front-end

When parsing a comment with a style like this: ``` /** Multiline comment * with subsequent lines indented two spaces * breaks Jazzy. */ ``` Jazzy ends up producing documentation...

enhancement
sourcekitten
feature

Note that as per [the official documentation](https://developer.apple.com/library/content/documentation/Xcode/Reference/xcode_markup_formatting_ref/BulletedLists.html#//apple_ref/doc/uid/TP40016497-CH9-SW1) switching between `*`, `-` and `-` should start new lists. That is, ```md * a - b + c ``` should result in...

bug
redcarpet