search

realm / jazzy

Soulful docs for Swift & Objective-C
https://realm.io
MIT License
7.35k stars 413 forks source link

Mixed Framework Swift & Obj-c documentation #1304

Closed atacand1920 closed 2 years ago

atacand1920 commented 2 years ago

Using the sourcekitten command lines then Jazzy from the generated json files , how can we exclude some objective-c headers if we use sourcekitten command lines ?

johnfairh commented 2 years ago

The jazzy exclude & include flags are applied to the output of the sourcekitten phase so they should work normally. You should be able to see what the tools think each file is called in the json.

atacand1920 commented 2 years ago

tried like this but it doesn't exclude the files: jazzy --sourcekitten-sourcefile objcDoc.json,swiftDoc.json --exclude a.h,b.h (a and b are the files that i need to exclude from the documentation)

johnfairh commented 2 years ago

Check the readme for instructions on how to use --exclude -- if you do that & still have no luck then we'll need a full example.

atacand1920 commented 2 years ago

Well, i used the :nodoc: keys and it worked like that, so we can not use --exclude after all. Thank you