API documentation created

Summary:

I edited the jiglibx source files to generate an MSDN style api reference.

API documentation created

codepigeon 09 Nov 2010 02:16

Please let me know if this is usefull. I took the latest source and added xml style comments to all functions and public members. I used Sandcastle to generate MSDN style documentation.

(hopefully this link works)
See freestorage_location_of_html_files for a zip file that contains the webpages. Open "index.html" to start.

There is still ALOT of work to be done documenting what each function does. In the absense of knowing what a function does, i set the <summary> to be equal to the function name.

I would like to commit the changes to the source, but codeplex says that the source control servers are down.

Comment/Complaints welcome,
codepigeon

Re: API documentation created

codepigeon 09 Nov 2010 02:47

Well, now it appears that I don't have permission to commit changes. If anyone would like to see my changes, let me know. I only made chages to comments. I can post the changes to source to some free storage site.

noone (guest) 09 Nov 2010 18:49

Hi, give me your Codeplex username and I give you the needed rights.

Re: API documentation created

codepigeon 12 Nov 2010 01:52

Update: Don't use the link I provided in my initial comment. I made some fixes to the documentation that Sandcastle builds. Please note that if you like this style documentation, visit the Sandcastle Help File Builder page on Codeplex to download the tools to build MSDN style documentation (or .chm, pdf i think, etc).

I commited the latest build of this documentation to the svn source. I don't know if the Coordinators will accept this or not, so building it yourself is trivial.

Use this tutorial to get started:
http://broadcast.oreilly.com/2010/09/build-html-documentation-for-y.html

Re: API documentation created

RavenAll 12 Nov 2010 07:54

So,i've first to follow the tutorial and install sandcastle builder and after "install" you're commented files right?
I'm going to try it,if it work you've done a great thing!

---

>>The SoftWave:Programmers community<<

Re: API documentation created

codepigeon 17 Nov 2010 04:29

Thanks RavenAll. I haven't done much, but i hope its a step in a good direction!
I hope more people will get involved with documenting what the different methods(functions) do, and add descriptions for the parameters to the functions within the comments of the code.

I am impressed with the capabilities and ease of use of SandCastle(apparently it was part of one of the MS SDKs ?). Now that I have discovered it, it will be a tool I use for my personal projects. :)