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

Generate docs only for public symbols #116

Merged
merged 4 commits into from
Jul 31, 2020
Merged

Generate docs only for public symbols #116

merged 4 commits into from
Jul 31, 2020

Conversation

ApolloZhu
Copy link
Contributor

Changes

  • Renders only symbols that are public
  • To fix problem with protocol conformances not showing up, now assumes Unknown isPublic. This is a little shaky, but if we can use it without knowing the source, it should be public, right?

Before

image

# Where private declarations are shown:

image

# And because Node is private, when clicking on it, you'll get:

image

After

image

Full TOC now don't have private members

image

ApolloZhu added 3 commits May 20, 2020 04:26
If you can access it from not where it's defined, it should be public.

This fixes protocol conformances not showing up.
@ApolloZhu
Copy link
Contributor Author

@mattt mattt added this to the 1.0.0-beta.4 milestone Jul 31, 2020
@mattt
Copy link
Contributor

mattt commented Jul 31, 2020

Sorry for not getting to this sooner, @ApolloZhu. This is an excellent PR, and am very happy to get this into the forthcoming beta release. Thank you!

@mattt mattt merged commit ed4a680 into SwiftDocOrg:master Jul 31, 2020
mattt added a commit that referenced this pull request Jul 31, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants