Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Framework Support #317

bjtitus opened this Issue Feb 13, 2013 · 4 comments


None yet
2 participants

bjtitus commented Feb 13, 2013

I'm working on some changes to add in Framework support but wanted to go ahead and an an issue to keep track of.

@tomaz Have you thought at all about how this might be done? I just added a new object type and am going to keep track of that. I just look for .framework in the path My initial stuff is here: bjtitus/appledoc@3850cd5

I hope to have some more tomorrow and might submit a pull request then.


tomaz commented May 17, 2013

Sorry for late reply... Can you post a ref to example of what you're trying to accomplish (presumably inside Apple's docs)? Just so I can make it clearer :)


bjtitus commented May 17, 2013

At its most basic, it simply adds a line like the Framework line seen in class references: http://developer.apple.com/library/ios/documentation/uikit/reference/UILabel_Class/Reference/UILabel.html (like the one for UIKit in UILabel).

It would also list the frameworks on the index page of the documentation. I don't think there's a corresponding page for something like that in Apple's docs.

I've already got a working version of this but there are a few bugs and no tests yet. I can send you more details and screenshots from the implementation later this weekend.


tomaz commented May 17, 2013

Oh, right! No rush, I'm away for the whole week anyway :)


bjtitus commented Jun 7, 2013

Sorry for the delay,

Here's a quick screenshot showing what I was thinking. The frameworks are listed on the index page under the "Framework References" section and they have detail pages at "/Frameworks/FRAMEWORK_NAME" and then the framework is linked in the class reference like in Apple's documentation (but without the path for now).

Let me know what you think.

napkin 06-06-13 9 54 28 pm

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