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.

Documentation links to non-existent internal protocols #301

@DominikBucher12

Description

@DominikBucher12

Example:

protocol InternalProtocol {}
public class PublicClass: InternalProtocol { }

Documentation for PublicClass is generated with inheritance section which points out to InternalProtocol which links to file which doesn't exist since it's internal.

This mention should probably not exist at all since it's internal and it doesn't affect public API generated by documentation.

Activity

Lukas-Stuehrk

Lukas-Stuehrk commented on Aug 27, 2021

@Lukas-Stuehrk
Member

Thanks for reporting, @DominikBucher12.

Do you mind sharing which output format you are using? This seems to work when generating the html documentation, but is broken when generating the commonmark documentation.

linked a pull request that will close this issue on Aug 27, 2021
DominikBucher12

DominikBucher12 commented on Aug 30, 2021

@DominikBucher12
Author

Hello Lukas :)

The output format used is commonmark, sorry not to include earlier. :)

Have a nice day

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

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @Lukas-Stuehrk@DominikBucher12

      Issue actions

        Documentation links to non-existent internal protocols · Issue #301 · SwiftDocOrg/swift-doc