Skip to content

Support for skipping synthesized symbols #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
franklinsch opened this issue Aug 30, 2022 · 2 comments · Fixed by #28
Closed

Support for skipping synthesized symbols #27

franklinsch opened this issue Aug 30, 2022 · 2 comments · Fixed by #28
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@franklinsch
Copy link
Contributor

Feature Request: Support for skipping synthesized symbols

Description:

The Swift compiler supports a -skip-synthesized-members argument which excludes synthesized symbols from symbol graph files. Synthesized symbols can lead to a large increase in number of documentation pages for some frameworks. We should have a way of generating documentation without synthesized symbols from the DocC plugin.

@franklinsch franklinsch added the enhancement New feature or request label Aug 30, 2022
@ethan-kusters ethan-kusters added the good first issue Good for newcomers label Aug 30, 2022
@ethan-kusters
Copy link
Contributor

This would be a great first issue! To support this we would need to add support for parsing a new flag and then change the boolean we're passing here: https://github.com/apple/swift-docc-plugin/blob/main/Plugins/SharedPackagePluginExtensions/Target%2BdefaultSymbolGraphOptions.swift#L29

Here's an example of a custom flag the plugin currently supports: https://github.com/apple/swift-docc-plugin/blob/main/Sources/SwiftDocCPluginUtilities/PluginFlags/DisableIndexFlag.swift#L14.

Happy to help with any questions if anyone would like to take this on!

@natikgadzhi
Copy link
Contributor

Was looking around for good small issues to get myself up to speed — looks like this one is complete in #28, @sofiaromorales 👏🏼

@ethan-kusters, time to close this one? I would be happy to explore other issues and help out if I can, if you have anything that needs attention!

@Kyle-Ye Kyle-Ye linked a pull request Aug 13, 2024 that will close this issue
3 tasks
@Kyle-Ye Kyle-Ye closed this as completed Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants