swift-doc icon indicating copy to clipboard operation
swift-doc copied to clipboard

SwiftDoc should inherit delegate and superclass docs.

Open jshier opened this issue 5 years ago • 1 comments

It would be great if SwiftDoc's generated docs could inherit the inline documentation for protocol implementations and overrides. For example, Alamofire has a SessionDelegate type which implements the various URLSession*Delegate protocol methods we're interested in. In Xcode, those methods inherit the documentation from the protocol itself. For example:

Screen Shot 2020-04-01 at 9 14 56 PM

SwiftDoc currently generates only the method declarations.

jshier avatar Apr 02 '20 01:04 jshier

@mattt Any updates on this or tips on getting started to contributing to this feature? Would love it, particularly in the coverage command; I noticed that swift-doc coverage ... flags protocol implementations as undocumented, even if there is documentation at the protocol definition top level.

Happy to hack around on it myself if you don't think it would be super complicated.

joshuawright11 avatar Dec 31 '20 22:12 joshuawright11