SGDK2 Programming Reference

[bluemonkmn]

Wow, XML documentation is so cool.  It's not done yet, but you can get a peek at how nice the rule function documentation and coding documentation is going to be from here:
http://enigmadream.com/files/SGDK2DevRef.zip

I've been working on the documentation for the SpriteBase class, so that's where most of the nicest documentation is so far... but even that class isn't done yet.

[Jam0864]

It's really well organized. Easy to find what you want. 

[bluemonkmn]

Yah, these documentation tools are really nice to use:

• Visual Studio automatically creates comment blocks above each function with tags to describe each parameter and add a summary and remarks about the function itself.
• When Visual Studio compiles a project, is creates an XML file containing this documentation.
  
• NDoc (http://ndoc.sf.net/) uses this XML file and the compiled code together to generate documentation in a format identical to Microsoft's own MSDN documentation.

And practically all I have to do is fill in the blanks.  Programming and documentation has never been this fun .

[bluemonkmn]

Whew... I think I'm done documenting the code... the file link above has been updated with the completed programming documentation (has not been proofread yet).  Next I just have to link the main help into this help.