Awesome.. Now if only contributors helped with adding documentation to some of my classes..
CocoaDocs - Documentation for iOS Libraries
11–20 of 31 posts
Re: CocoaDocs - Documentation for iOS Libraries
#12Re: CocoaDocs - Documentation for iOS Libraries
#13That is great! Didn't know my lib is so well documented ;)
Not gonna plug your lib? :)
Re: CocoaDocs - Documentation for iOS Libraries
#14Hey guys & gals, I created cocoadocs to try and fill a gap in the iOS ecosystem. It's a site that acts similar to rubydocs in that it gets the latest cocoapods libraries and documents them using a custom flavour of appledoc. I'm planning on adding support for Xcode and Dash over the next few weeks to make it even easier to use!
I've been experimenting with adding Github search links for methods and properties too - so you can get context on their uses ( this has them when you mouse over further down the page: http://cocoadocs.org/docsets/AFIncrementalStore/0.4.0/Classe... )
Re: CocoaDocs - Documentation for iOS Libraries
#15Doesn't have anything on AvFoundation. That's kind of my litmus test.
AVFoundation is an apple library, which isn't on cocoapods meaning cocoadocs doesn't support it. Apple do their own documentation pretty well and I don't really see a need to duplicate that to be honest.
They do provide great docs.
But if you're solving a find-ability the drop down list could either include those results or provide a redirect. This would just be an easy workflow thing.
Also, you're attempting to reflect the rubydocs ecosystem. An ecosystem which includes (core and stdlib) and gems. If you're reflecting that system accurately, you should include apple docs, and pods accordingly.
Just my two cents.
Re: CocoaDocs - Documentation for iOS Libraries
#16Earlier quoted context omitted.
AVFoundation is an apple library, which isn't on cocoapods meaning cocoadocs doesn't support it. Apple do their own documentation pretty well and I don't really see a need to duplicate that to be honest.
They do provide great docs. But if you're solving a find-ability the drop down list could either include those results or provide a redirect. This would just be an easy workflow thing. Also, you're attempting to reflect the rubydocs ecosystem. An ecosystem which includes (core and stdlib) and gems. If you're reflecting that system accurately, you should include apple docs, and pods accordingly. Just my two cents.
I agree, I think redirecting to apple's libraries is a great idea! When the grand-parent said a lack of AVFoundation was a problem, I interpreted that as "you should document that" but I think linking to all of Cocoa/UIKit is a real useful feature. Thanks 1qaz2wsx3edc.
Re: CocoaDocs - Documentation for iOS Libraries
#17Hey guys & gals, I created cocoadocs to try and fill a gap in the iOS ecosystem. It's a site that acts similar to rubydocs in that it gets the latest cocoapods libraries and documents them using a custom flavour of appledoc. I'm planning on adding support for Xcode and Dash over the next few weeks to make it even easier to use!
If you provide a /search?query=%s endpoint I would build an Alfred V2 Workflow for it. Downloading the whole documents.jsonp file each time is slow.
Re: CocoaDocs - Documentation for iOS Libraries
#18Doesn't have anything on AvFoundation. That's kind of my litmus test.
Err, this is about CocoaPods. You can go to ADC for AVFoundation.
Re: CocoaDocs - Documentation for iOS Libraries
#19Fantastic! I can see this being incredibly useful for cases where you have multiple versions of a framework used in different projects. Right now you can install documentation into Xcode if the project uses appledoc[1], but there's no way to switch between versions.
On the subject of appledoc, are you using a custom template here? It seems to improve on the default one in a few places.
Re: CocoaDocs - Documentation for iOS Libraries
#20Doesn't have anything on AvFoundation. That's kind of my litmus test.
AVFoundation is an apple library, which isn't on cocoapods meaning cocoadocs doesn't support it. Apple do their own documentation pretty well and I don't really see a need to duplicate that to be honest.
Ah I see. It wasn't clear (to me at least) that this wasn't meant to be globally inclusive. My initial take was that you were trying to make a better overall docs system for Obj-c. Having links back to the current definitive Apple docs would be great.