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

Documentation links to non-existent internal protocols #301

Open
DominikBucher12 opened this issue Jun 11, 2021 · 2 comments · May be fixed by #309
Open

Documentation links to non-existent internal protocols #301

DominikBucher12 opened this issue Jun 11, 2021 · 2 comments · May be fixed by #309
Labels
bug Something isn't working

Comments

@DominikBucher12
Copy link

DominikBucher12 commented Jun 11, 2021 •
edited

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.
@Lukas-Stuehrk
Copy link
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.

@Lukas-Stuehrk Lukas-Stuehrk linked a pull request Aug 27, 2021 that will close this issue
Open
@DominikBucher12
Copy link
Author

Hello Lukas :)

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

Have a nice day

@Lukas-Stuehrk Lukas-Stuehrk added the bug Something isn't working label Aug 31, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix included symbols Lukas-Stuehrk/swift-doc
2 participants
@Lukas-Stuehrk @DominikBucher12