Documentation

Moderator: Jim

Documentation

Postby thomthom » Fri Jun 19, 2009 9:07 am

Maybe we should add to the method documentation what version the methods are compatible with? Maybe adding a comment line in the code as well. I'm thinking just looking at the SU API docs and checking the methods we use instead of actually testing each method.
0
Thomas Thomassen — SketchUp Monkey & Coding addict
List of my plugins and link to the CookieWare fund
User avatar
thomthom 
PluginStore Author
PluginStore Author
 

Re: Documentation

Postby Chris Fullmer » Fri Jun 19, 2009 5:06 pm

I think thats not bad, but maybe we should only use major releases. At this point, we're still developing a first release. Seems like that is only important once you add new features to a 2nd public release.
0
Lately you've been tan, suspicious for the winter.
All my Plugins I've written
User avatar
Chris Fullmer 
SketchUp Team
SketchUp Team
 

Re: Documentation

Postby thomthom » Fri Jun 19, 2009 5:15 pm

I was thinking of indicating what SU versions our methods require.
0
Thomas Thomassen — SketchUp Monkey & Coding addict
List of my plugins and link to the CookieWare fund
User avatar
thomthom 
PluginStore Author
PluginStore Author
 

Re: Documentation

Postby Chris Fullmer » Fri Jun 19, 2009 5:44 pm

Ahh, gotcha! that didn't cross my mind. At this point I haven't worked on anything that is incompatible with any versions. Makes sense.

Chris
0
Lately you've been tan, suspicious for the winter.
All my Plugins I've written
User avatar
Chris Fullmer 
SketchUp Team
SketchUp Team
 

Re: Documentation

Postby Jim » Sat Jun 20, 2009 7:13 pm

What version of SketchUp did the Ruby API first ship with? 4? I know version 5 had it - that's when I started with it.

The current API makes no mention of anything before version 6, though.

I have been wading through the RDoc documentation is hopes finding a clue on how to write a custom output generator to output Google Code wiki syntax from rdoc. I am not any closer to understanding it than I was a week ago. I am now looking at a document generator called yard (which is RDoc compatible) that is better documented than RDoc.

But I agree, if a library methods relies on a certain version of the API, then it needs to be documented.
0
Hi

Jim 
Global Moderator
 

Re: Documentation

Postby thomthom » Sat Jun 20, 2009 7:18 pm

I think it's 4.
But that's why struck me, the API docs only dates back to SU6.
0
Thomas Thomassen — SketchUp Monkey & Coding addict
List of my plugins and link to the CookieWare fund
User avatar
thomthom 
PluginStore Author
PluginStore Author
 

Re: Documentation

Postby Chris Fullmer » Sat Jun 20, 2009 7:24 pm

I have not pulled the wiki files to see what they look like. Are they just text? or html files? I use RDoc for all my scripts (though I'm not really testing to see how great it comes out in Rdoc, and I don't document my methods like I should for RDoc). But it seems like there should be a way to make rdoc output into a good format for the wiki.

Maybe I'll pull the wiki repo and check it out too. If not rdoc, yard sounds promising then. Anything would be good.

Have you looked into the Google wiki docs to see if they recommend a method?

Chris
0
Lately you've been tan, suspicious for the winter.
All my Plugins I've written
User avatar
Chris Fullmer 
SketchUp Team
SketchUp Team
 

Re: Documentation

Postby Chris Fullmer » Sat Jun 20, 2009 7:25 pm

Or we could write our own Ruby Script parser and implement our own ruby markup system so we can format it how we want. Hehehe, since none of us have anything else to work on :)
0
Lately you've been tan, suspicious for the winter.
All my Plugins I've written
User avatar
Chris Fullmer 
SketchUp Team
SketchUp Team
 

Re: Documentation

Postby thomthom » Sat Jun 20, 2009 7:31 pm

Work + CityGen + Skx + Doublecut + Beta testing + Architectural competition + real life + summer + Custom RDoc parser..? :?
0
Thomas Thomassen — SketchUp Monkey & Coding addict
List of my plugins and link to the CookieWare fund
User avatar
thomthom 
PluginStore Author
PluginStore Author
 

SketchUcation One-Liner Adverts

by Ad Machine » 5 minutes ago



Ad Machine 
Robot
 



 

Return to Skx Extension Library

Who is online

Users browsing this forum: No registered users and 1 guest

Visit our sponsors: