jazzy
jazzy copied to clipboard
realm
Soulful docs for Swift & Objective-C
I'm thinking of having SourceKitten generate a line range which we can use to link to GitHub, and which we can read from jazzy if the file paths are present.
Even though Swift operators are technically functions I think it would be useful to at least optionally list operators under their own heading. Especially in [this case](http://kareman.github.io/SwiftShell/) where there is...
Jazzy uses USRs for URLs because Swift allows overloading declarations with the same name, but with different type signatures. However, since overloading is the minority case, we could use the...
When creating an empty iOS/OSX framework jazzy will produce countless screens of useless output that ends with ``` ... Failed to generate documentation from /Users/tkrajacic/.rbenv/versions/2.1.3/lib/ruby/gems/2.1.0/gems/jazzy-0.3.1/lib/jazzy/sourcekitten.rb:115:in `run_sourcekitten' from /Users/tkrajacic/.rbenv/versions/2.1.3/lib/ruby/gems/2.1.0/gems/jazzy-0.3.1/lib/jazzy/doc_builder.rb:56:in `block in...
If `Foo` is a type, then this: ``` - See: Foo ``` …should produce the same results as this: ``` - See: `Foo` ``` Questions: - Support any other special...
Couldn't find an easy config setting for this, so filing a feature request :) It would be nice if there was a way - either in the web interface or...
In testing the ObjC docs parsing (#367), I found that `@discussion` is not parsed. However, `@note` **does** work, so this probably isn't high priority to fix. I'm assuming this is...
From #370: > However, PSPDFKit really highlights that jazzy needs some performance optimizations to handle larger projects gracefully. Generating docs for your project takes ~50 seconds on my Macbook Pro!...
This should be a lot simpler than doing the same of Swift. /cc @segiddins
Our code is commented as follows: ``` /// First line of comment. /// Second line of comment /// @note This is a note. /// Final line of comment. ``` The...
