Allow ignoring files

[K4stor]

Hi there,

is there a way to leave files out of the documentation ?
Like the appdelegate. I dont wanna document that one :D

And ofc, thanks for dat awesome tool

Regards

[jpsim]

@K4stor it's not currently possible, though it should be pretty easy to do.

[bryanbartow]

I second this request. It would be extremely helpful (for me at least).

[jessesquires]

Can't you use this?

/// :nodoc:

[bryanbartow]

@jessesquires That doesn't seem to have any effect for me.

[jessesquires]

@bryanbartow , here's a working example

[jpsim]

You can use /// :nodoc: to ignore explicit declarations, but not entire files.

Adding a feature to ignore files should be very easy: it's just a matter of adding an --ignored-files CLI argument in config.rb and then filter SourceKitten's output based on that list of files in sourcekitten.rb.

[jpsim]

I've opened #219 as a possible implementation of this feature. Let me know what you think!