jazzy
jazzy copied to clipboard
Show types if parameter labels are not sufficient to disambiguate
Currently, documentation generated from code like this:
struct Foo {
init(_ id: Int) { ... }
init?(_ json: String { ... }
}
looks like this:

This is not very helpful.
If function name and parameter labels are not enough to disambiguate (detect by string equality), we need to see parameter and/or return types.
I for one would appreciate a setting that enables showing types "everywhere", but an automatism that shows as little as possible would make a lot of sense, imho.
(Arguably, the ? should always carry over!)
+1 We would like this as well (Kitura.io)
Agreed on all counts.