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

Following links to internal base classes leads to 404 error #177

Closed
rolson opened this issue Sep 2, 2020 · 4 comments
Closed

Following links to internal base classes leads to 404 error #177

rolson opened this issue Sep 2, 2020 · 4 comments
Labels
bug Something isn't working

Comments

@rolson
Copy link

rolson commented Sep 2, 2020

Doc for internal classes is not generated (good). But the internal base classes and protocol conformances are listed and appear as links. Following these links naturally leads to 404 (bad) as the doc for those types are not generated.

One proposal is to not make internal types links.

Here is a screen-shot of some inheritances of internal types conformances of internal protocols showing as links:

image

@mattt
Copy link
Contributor

mattt commented Sep 3, 2020

@rolson My understanding is that public classes can't inherit from non-public superclasses or adopt non-public protocols. Would you mind sharing a minimal example that reproduces this (and also compiles)?

@rolson
Copy link
Author

rolson commented Sep 3, 2020

You are correct, and I misspoke, sorry. The issue is with internal protocol conformances.

This compiles and exhibits the issue:

import Foundation

public class Foo: Bar { }

internal protocol Bar { }

@Lukas-Stuehrk
Copy link
Member

This has been fixed in the latest release (1.0.0-beta.6).

@rolson
Copy link
Author

rolson commented May 11, 2021

Unless I'm generating this incorrectly, this problem does seem fixed. Although for public superclasses, I cannot tap them anymore:

image

In this image, the superclass Renderer should be a link.

Also, I am finding that the documentation for members is also not creating links for types within this module:

image

In the above image UniqueValue should be a link, correct? I can create an enhancement request for this if one does not exist, please advise.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants