Ok, my first complete swipe for the new docs (but still with old rdoc default output templates) can be seen at: http://www.mktec.com/dev_www/wxruby-docs/ Most of the classes/methods documentation came out fine, but I still need finetune because some methods don''t get documented at all, like methods in the classes Bitmap and Frame. Once I can get it so all things get documented I''m going to work on the template for rdoc output. After the template is done, I am going to work on filtering the documenation and to create links and modify cpp style method names to ruby-style names. For example where it would say "wxApp::SetTopWindow" I would change that into a link "App::set_top_window" I hope to have more progress later tonight. Zach
Hi Zach Nice one. Just a couple of things from a first scan = you maybe picked them up already - the methods don''t show up with the argument description - they all show as 0-args - the class listing seems to end after Wx::Image, nothing for Wx::ImageList onwards but basically just wanted to say great, thanks alex Zach Dennis wrote:> Ok, my first complete swipe for the new docs (but still with old rdoc > default output templates) can be seen at: > > http://www.mktec.com/dev_www/wxruby-docs/ > > Most of the classes/methods documentation came out fine, but I still > need finetune because some methods don''t get documented at all, like > methods in the classes Bitmap and Frame. > > Once I can get it so all things get documented I''m going to work on the > template for rdoc output. After the template is done, I am going to work > on filtering the documenation and to create links and modify cpp style > method names to ruby-style names. For example where it would say > "wxApp::SetTopWindow" I would change that into a link "App::set_top_window" > > I hope to have more progress later tonight. > > Zach > _______________________________________________ > wxruby-users mailing list > wxruby-users@rubyforge.org > http://rubyforge.org/mailman/listinfo/wxruby-users > >
> - the class listing seems to end after Wx::Image, nothing for > Wx::ImageList onwardsActrually it may be a browser issue - I can see those fine (Firefox 1.0 on WinXP). Zach, I know it''s early but you have a typo... In the headers for the classes you have: "This class documentation has been created automatically generated". Hope I''ll get the chance to go over it in more detail soon. Cheers, Assaph
Totally awesome! :-) Great progress, Zach. This will be far superior to the current docs. Nick Zach Dennis wrote:> Ok, my first complete swipe for the new docs (but still with old rdoc > default output templates) can be seen at: > > http://www.mktec.com/dev_www/wxruby-docs/ > > Most of the classes/methods documentation came out fine, but I still > need finetune because some methods don''t get documented at all, like > methods in the classes Bitmap and Frame. > > Once I can get it so all things get documented I''m going to work on the > template for rdoc output. After the template is done, I am going to work > on filtering the documenation and to create links and modify cpp style > method names to ruby-style names. For example where it would say > "wxApp::SetTopWindow" I would change that into a link "App::set_top_window" > > I hope to have more progress later tonight. > > Zach > _______________________________________________ > wxruby-users mailing list > wxruby-users@rubyforge.org > http://rubyforge.org/mailman/listinfo/wxruby-users > > >
alex fenton wrote:> Hi Zach > > Nice one. Just a couple of things from a first scan = you maybe picked > them up already > > - the methods don''t show up with the argument description - they all > show as 0-argsThanks for pointing this out, this is another thing I need to implement. Right now I''m not parsing out arguments, but this should be easy to add functionality for how the documentation is getting parsed. Zach
Assaph Mehr wrote:>>- the class listing seems to end after Wx::Image, nothing for >>Wx::ImageList onwards > > > Actrually it may be a browser issue - I can see those fine (Firefox > 1.0 on WinXP). > > Zach, I know it''s early but you have a typo... > In the headers for the classes you have: "This class documentation has > been created automatically generated".Thanks for pointing this out, I wrote it once, then decided to change it, then started changing it, then my wife called me to eat...and I forgot about it since! I''ll change this and add a date/time stamp. Zach
Nick wrote:> > Totally awesome! :-) > > Great progress, Zach. This will be far superior to the current docs. > > Nick+1+1+1+1+1+1... Curt> Zach Dennis wrote: > > Ok, my first complete swipe for the new docs (but still with old rdoc > > default output templates) can be seen at: > > > > http://www.mktec.com/dev_www/wxruby-docs/ > > > > Most of the classes/methods documentation came out fine, but I still > > need finetune because some methods don''t get documented at all, like > > methods in the classes Bitmap and Frame. > > > > Once I can get it so all things get documented I''m going to work on the > > template for rdoc output. After the template is done, I am > going to work > > on filtering the documenation and to create links and modify cpp style > > method names to ruby-style names. For example where it would say > > "wxApp::SetTopWindow" I would change that into a link > "App::set_top_window" > > > > I hope to have more progress later tonight. > > > > Zach > > _______________________________________________ > > wxruby-users mailing list > > wxruby-users@rubyforge.org > > http://rubyforge.org/mailman/listinfo/wxruby-users > > > > > > > > _______________________________________________ > wxruby-users mailing list > wxruby-users@rubyforge.org > http://rubyforge.org/mailman/listinfo/wxruby-users > > -- > No virus found in this incoming message. > Checked by AVG Anti-Virus. > Version: 7.0.300 / Virus Database: 265.8.5 - Release Date: 2/3/2005 >
alex fenton wrote:> - the class listing seems to end after Wx::Image, nothing for > Wx::ImageList onwardsAh, i see what you are saying. They show up on the list, but not when you click on the link for the classes after Image. I think this was an ftp problem. I saw it error''d out on something, but didn''t pay to much attention to what it was. On the Second Look I''ll make sure they''re all up there. thx Alex, Zach