So what do you do?

| | Comments (3)

So I'm curious to know how many of you develop toolkits and use encrypted items to distribute them? What I'm mostly interested in is: how do you document the external APIs? With the GDI+ project, I have a ton of APIs which I need to write some rudimentary docs for, and I don't relish the idea of writing them all by hand. So I've had the idea of spitting them out in a version control format directory and parsing the files manually to extract the declarations. At least that gets me a starting point for the docs. I've looked for RB doc generators, since I figured someone must have done this stuff before. I found two, but neither would work. One was for a very old version of RB and was Mac-only. The other was from SirG3 (you've probably seen him posting here before), but the link was dead.

So does no one have a doc generator? Are they just not that useful? Or do you have a custom solution that you use?

3 Comments

Hm, I'll work on RbDocGen now..... I lost interest in working on it after there was no feedback for the initial preview or at the REALworld session =/. I _think_ all that needs to be done is fix up the RbScript template stuff, finish the default template, and uhm.... get it working on the Mac.

I'd be interested in using it. I need it to spit out prototypes for methods, properties, enums, structures, etc. If I can write docs in code, that'd help as well. I'm mostly just looking for something to get me started.

Joe, I've been eagerly waiting to see RbDocGen on the Mac. The only other documentation tool, RB-ADoc, hasn't been updated since 2004.

Leave a comment

Disclaimer

I'm currently an employee of REAL Software. My blog is mine. The opinions represented in this blog are mine as well and may not represent my employer's opinions. All original material is copyrighted and property of the author.

REALbasic® is a registered trademark of REAL Software, Inc. REAL SQL Server™ and Lingua™ are pending trademarks of REAL Software, Inc. All rights reserved.