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

Option to exclude Swift types #858

Open
drekka opened this issue Jul 17, 2017 · 2 comments
Open

Option to exclude Swift types #858

drekka opened this issue Jul 17, 2017 · 2 comments

Comments

@drekka
Copy link

drekka commented Jul 17, 2017

Currently we can exclude source classes from the generated documentation using --exclude file.

But sometimes we have multiple sources in a single file, some of which we want to exclude and some we want to document. For example, we might have a public protocol and a private implementation.

I'd like to suggest adding a variation on --exclude that lets us specify the exclusion of a type rather than a source file. Something like:

---excludeType type1,ty*,*pe*

Notice the option to use wildcards to also allow us to exclude groups. For example we might want to do something like --excludeType *Impl.

@SDGGiesbrecht
Copy link
Contributor

@drekka, the wildcards are an interesting new idea.

One does already have a lot of control over excluding symbols by marking them with /// :nodoc:. Also, --skip-undocumented and --min-acl directly deal with what I suspect are the most common usage cases. Are any of those helpful for what you are trying to do?

@drekka
Copy link
Author

drekka commented Jul 17, 2017

/// :nodoc: sounds promising. In my case I'm producing an API and want to hide classes which have to be public, but I don't want developers to see. For example, I was developers to use a variety of final public classes, but not be able to see the parent abstract class they inherit from.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants