SwiftDocOrg / swift-doc

A documentation generator for Swift projects
https://swiftdoc.org
MIT License
1.68k stars 100 forks source link

Documentation links to non-existent internal protocols #301

Open DominikBucher12 opened 3 years ago

DominikBucher12 commented 3 years ago

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 commented 2 years ago

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.

DominikBucher12 commented 2 years ago

Hello Lukas :)

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

Have a nice day