Skip to content
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

Swift extensions containing MARKs are unconditionally documented #544

Closed
kykim opened this issue Apr 27, 2016 · 3 comments
Closed

Swift extensions containing MARKs are unconditionally documented #544

kykim opened this issue Apr 27, 2016 · 3 comments
Assignees
Labels
Milestone

Comments

@kykim
Copy link

kykim commented Apr 27, 2016

Not sure what's triggering this. Posting this in hopes that someone might be able to give me a lead on how to debug this further.

@segiddins
Copy link
Collaborator

Could you share an example of code that triggers this happening, please?

@kykim
Copy link
Author

kykim commented Apr 27, 2016

https://github.com/projectorhq/ios-sdk

I use the command

jazzy --clean --module-version master --min-acl public --output docs

Under the Services category, the class APIService is visible, even though it's an internal class. The other classes in that category are properly excluded.

HtH!

@jpsim jpsim changed the title docs for _some_ internal types with --min-acl public Swift extensions containing MARKs are unconditionally documented May 19, 2016
@jpsim
Copy link
Collaborator

jpsim commented May 19, 2016

The issue here is that Swift extensions don't have an inherent ACL, so we consider it for documentation only if it contains members that should be documented (generally declarations), but we consider MARK comments as "always documentable declarations". #563 should fix this.

Thanks for reporting this issue!

esad pushed a commit to PSPDFKit-labs/jazzy that referenced this issue May 27, 2016
@pigeondotdev pigeondotdev modified the milestone: The Past Nov 22, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants