Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

SwiftDoc should inherit delegate and superclass docs. #36

@jshier

Description

@jshier

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.

Activity

joshuawright11

joshuawright11 commented on Dec 31, 2020

@joshuawright11

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @mattt@jshier@joshuawright11

        Issue actions

          SwiftDoc should inherit delegate and superclass docs. · Issue #36 · SwiftDocOrg/swift-doc