jazzy
jazzy copied to clipboard
realm
Soulful docs for Swift & Objective-C
Say we have something like this: ```swift class A { func foo() {} } class B: A {} ``` We would then expect `B.foo()` to auto-link to `A.foo()`, which currently...
I have noticed that `output` and `readme` seem to be relative to the config file but `documentation` and `abstract` are relative to the current working directory. My setup: ``` myproject...
I don't necessarily want information like author and date of symbols in public documentation. Therefore, I'd need to tell Jazzy to just drop `- Author:` and `- Date:` callouts unless...
Currently, there is no efficient way to go from a protocol to all conforming classes and structs, or from classes to all subclasses. This connection is essential when exploring an...
Say I have a file `My Guide.md` that I include in a custom category. I have to name it thus to that I get `My Guide` in the menu of...
Currently, you can use the `:nodoc:` token to exclude specific declarations but in cases where you have to do many overrides (such as a framework of `UIView`s), completely ignoring all...
This may be controversial, but I think raw values of enums are *designed* to be internal: we use the enum to have the abstraction after all. So instead of ```swift...
Say I have a setup similar to this: ```swift internal protocol Foo {} public protocol Bar public struct FooBar: Foo, Bar {} ``` I do not want the documentation of...
I collect symbols in custom categories. Despite the fact that they are all `public`, I get "Public" headers in the index list. Exhibit A: ![screen shot 2017-04-24 at 17 45...
Currently, Jazzy does not visually distinguish cases and members of enums. It would be nice to have special treatment for enum cases. Since there is no distinguishing criterion between "enum...