At 01:27 +0000 12/3/08, Chris McGrath wrote: > One thing I've been considering since watching your RubyConf > presentation via confreaks is ...
Just to be clear, Rich Kilmer is the HC developer that made the RubyConf presentation; I'm just a MacRuby and HotCocoa wannabe... > ... auto-generating documentation about what's mapped to what. > I haven't looked at the code enough to know if it's feasible, > but I'd like to see something like: > > text_field -> NSTextField (selectable: false, bordered: false, ...) > #i.e. the defaults > > Most of these would be obvious, but are currently "hidden" away down > in the MacRuby source. I'd like to see mappings both ways, so as > someone who knows a bit of cocoa I can easily go check if NSFoo has > been wrapped by someone and what the wrappings are. I love how the > mappings are implemented, but I won't be able to keep them all in my > head! OK; here's a partly-baked idea, loosely inspired by Python docstrings. <PBI> The HC declarations are (I assume) stashing information away in some sort of data structure. If not, they certainly could be (:-). Once the information is available at runtime, any HC script could retrieve them for use in online documentation. Of course, as RK indicates, HC is lazy about loading frameworks. So, a comprehensive documentation generator would have to force loading of all possible frameworks. It may also be that HC doesn't store as much information as we'd like to have in the docs. No problem; add a few more methods (etc) to let developers add these "annotations". </PBI> -r -- http://www.cfcl.com/rdm Rich Morin http://www.cfcl.com/rdm/resume [EMAIL PROTECTED] http://www.cfcl.com/rdm/weblog +1 650-873-7841 Technical editing and writing, programming, and web development _______________________________________________ MacRuby-devel mailing list MacRuby-devel@lists.macosforge.org http://lists.macosforge.org/mailman/listinfo.cgi/macruby-devel