Shipped with the rubycocoa source is a tool which parses the Apple Objective-C html reference files and transforms the Objective-C methods to the way that calling is done from Ruby. The outputted ruby source files are then passed to rdoc which creates HTML files and places them in /Developer/Documentation/RubyCocoa/Frameworks/. It also creates files that can be used by ri or fastri.
For instructions on creating the documentation please refer to GettingStarted.
For instructions on using the documentation please refer to FrameworkDocumentation.
For instructions on creating the documentation please refer to GettingStarted.
For instructions on using the documentation please refer to FrameworkDocumentation.
Requirements
- Hpricot 0.4 (newer versions won't work, unless you're using the source from trunk which supports Hpricot 0.5 since revision 1810)
$ gem install hpricot --version 0.4
- The latest Apple Reference updates installed, which is from 07-05-2007
External References
http://www.superalloy.nl/blog/?p=6∞ Introduction to BridgeDoc.TODO
- Parse pointers in method arguments and translate that to the way it's done in RubyCocoa, since we don't have pointers, eg:
res = elementAtIndex_associatedPoints(index, points) # real method where points should be a pointer (to an array in this case)
[res, pointer_res] = elementAtIndex_associatedPoints(index) # RubyCocoa method, so we omit the pointer and it will simply be returned.
[res, pointer_res] = elementAtIndex_associatedPoints(index) # RubyCocoa method, so we omit the pointer and it will simply be returned.