jazzy Multi-framework Doc Generation for Obj-C

Multi-framework Doc Generation for Obj-C

Open nlutsenko opened this issue 9 years ago • 10 comments

Love that jazzy now supports Obj-C doc generation. Would be awesome to have support for projects/frameworks that depend on other frameworks. E.g. Parse depending on Bolts.framework Or even Parse + ParseUI + ParseFacebookUtils, which all are multi-framework things.

The current one (that I could get working) would simply bundle all these things into a single generated output, which is probably not the best case. Or doing this separately involves creating separate sub-folders and adding a bunch of exclude file options for every single framework generation.

I might also have missed something and this is possible automatically through some options. If not - would love to brainstorm on the potential solutions here...

Nov 16 '15 23:11 nlutsenko

Probably possible by setting the correct header/framework search paths?

Nov 16 '15 23:11 segiddins

I probably should have been explicit - I am looking for ObjC solution here. To the best of my knowledge going through xcodebuild process, which is where search paths would matter is unsupported for ObjC, and work only for projects build in Swift...

Nov 17 '15 00:11 nlutsenko

Clang cares very much about search paths 😄

Nov 17 '15 00:11 segiddins

I want to greatly improve the ObjC doc generation experience, which is super janky at the moment. https://github.com/jpsim/SourceKitten/issues/88 would go a long way towards that, which would also allow us to filter which module headers belong to, which would then make documenting a single module out of a whole module graph much easier.