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

Documentation links to non-existent internal protocols

Open DominikBucher12 opened this issue 4 years ago • 2 comments

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.

DominikBucher12 avatar Jun 11 '21 10:06 DominikBucher12

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 avatar Aug 27 '21 06:08 Lukas-Stuehrk

Hello Lukas :)

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

Have a nice day

DominikBucher12 avatar Aug 30 '21 14:08 DominikBucher12