API Docs for GBPVR

[KingArgyle]

I've used ASMDoc and NDoc to create HTML documentation from the GBPVR assemblies used in the Web application. If it is alright with Sub, I can upload the zip file to the Wiki, so that an online reference for the API exists. It's easy enough to rerun whenever a new release is made.

This just gives the classes, methods, properites, and fields of each of the assemblies, no details or descriptions of what they actually do. Helpful though for a quick reference to see what a method will return.

Again, I won't upload it unless Sub gives his okay.

[sub]

Feel free to post it.

[blader_se]

It's now availible on the page http://www.bladerhq.com/pmwiki....YouNeed

[KingArgyle]

Bladder, one thing you may want to add to the Development Tools section, is Borland's C#Builder application. That is what I'm currently using as it not only supports .NET applications but also ASP.NET applications written in C#. It's free for personal use.

http://www.borland.com/

[blader_se]

Done.

I've also changed the capitalization of your username (same password). You may try to login again...

[sub]

Actually KingArgyle, you might want to remove GBPVRBackendCommon.dll from there. I dont really want users directly interacting with the objects exposed in that .dll, with the one exception of GBPVR.Backend.Common.ScheduleHelper. Everything in GBPVRPublic is fair game.

[KingArgyle]

I should be able to create an XSLT to massage the XML file produced by ASMDoc, that is used by Ndoc to create the files.

I'll see what I can come up with.

[aegisx]

don't forget Visual Studio

[KingArgyle]

In the Zip, there should be a CHM file. Which is just a standard compiled Help file.

This is really just a stop gap measure until Sub gets a chance to enable the creation of this document through Visual Studio. I don't use VS.NET as I'm using C#Builder (free for personal use from Borland.)

I'm from the Java world, and having a JAVADOC for an API is nice.

Sub, I tried removing all the Classes except for ScheduleHelper from the Backend docs that were generated, however, Ndoc 1.2 ignores the XML file, and generates directly from the Assemblies. NDoc 1.3 doesn't even require an XML file as input. The only way for me to control what is included in there would be to manually find where those classes are referenced in the files, and remove the links.

A suggestion would be, if you can, to move or probably easier, create a ScheduleHelper class in the Public namespace, and have it Implement the ScheduleHelper from the Backend. That way I can just generate the Public namespace, and not worry about the Common.Backend namespace.