Generating Documentation

[ConvertFromOldNGs]

by fargs >> Wed, 22 Sep 2004 23:02:58 GMT

Hi
I've built an Accounts - Transactions framework for small businesses and everything went smoothly except now i need to produce my documentation and i'm hoping to avoid writing all myself. Is there anything in jade that automatically generates api's and other such documentation from comments in the code? Something similar to the JDocs.

Thanks

[ConvertFromOldNGs]

by allistar >> Thu, 23 Sep 2004 1:17:30 GMT

Hi there,
There is nothing specific as far as I know, but you can get a hold of the source code for a method, which you could then easily parse to get method signatures and comments. The JadeMethod class has a property called "source".

We use this ability to automatically generate C++ code (for a DCOM component that usdes the JOMAPI) that thens gets compiled in a C++ compiler.

Regards,
Allistar.
--
------------------------------------------------------------------
Allistar Melville
Software Developer, Analyst allistar@silvermoon.co.nz
Auckland, NEW ZEALAND

Silvermoon Software
Specialising in JADE development and consulting
Visit us at: http://www.silvermoon.co.nz
*NEW* Simple web access to Jade at: www.silvermoon.co.nz/jhp.html ------------------------------------------------------------------

[ConvertFromOldNGs]

by bitsnz >> Thu, 23 Sep 2004 2:53:26 GMT

What about using the JadeReportWriterSchema?

Very easy to incorporate into any app plus it allows for most template report forms to be created.

The plumbing is all there you just need to be a good plumber to connect it all together

[ConvertFromOldNGs]

by bitsnz >> Thu, 23 Sep 2004 2:54:05 GMT

What about using the JadeReportWriterSchema?

Very easy to incorporate into any app plus it allows for most template report forms to be created.

The plumbing is all there you just need to be a good plumber to connect it all together

[ConvertFromOldNGs]

by Anonymous >> Thu, 23 Sep 2004 3:33:44 GMT

I actually started writing a script that just writes html code to a file and its working fine but i'm having an impossible time finding the documentation for the Property class. Does anyone know where i can find it? I should be able to get what i need after that. Thanks again

[ConvertFromOldNGs]

by allistar >> Thu, 23 Sep 2004 3:41:11 GMT

You can get JADE to tell you all properties and methods in a class, including the "Class" class and "Property" class.

There are collections (and maybe methods) on the "Class" class that will give you all properties for that class. Do this on the "Property" class and see what it comes up with.

Regards,
Allistar.
--
------------------------------------------------------------------
Allistar Melville
Software Developer, Analyst allistar@silvermoon.co.nz
Auckland, NEW ZEALAND

Silvermoon Software
Specialising in JADE development and consulting
Visit us at: http://www.silvermoon.co.nz
*NEW* Simple web access to Jade at: www.silvermoon.co.nz/jhp.html ------------------------------------------------------------------

[ConvertFromOldNGs]

by Anonymous >> Thu, 23 Sep 2004 4:05:48 GMT

Hi
How do i get jade to tell me all the properties and methods for a class. I'm probably missing something really stupid.

I should also mention i'm using a version downloaded off the website. This framework is a project for school and when i'm working from home.

fargs

[ConvertFromOldNGs]

by Anonymous >> Thu, 23 Sep 2004 5:53:22 GMT

Yes, it was something stupid. I just open up the root schema class browser. Thanks for the help.

[ConvertFromOldNGs]

by Darrell Duniam >> Thu, 23 Sep 2004 3:50:16 GMT

If you have BaseSchema, you can run the "BaseDocModel" application to generate HTML documentation of your schema(s).

If you want to look at how an instance of the Property class is documented, take a look at the Property::cnEcDocumentSelf method.

regards,
darrell.