Difference between revisions of "Development Docs"

From Armagetron
m
Line 1: Line 1:
 
This is documentation for developers or for people who just want to hack on the code.  It is not intended to replace the automatic API documentation generated by doxygen (we do have a doxyfile, right?), but is intended to supplement those documents with additional information that may not necessarily appear in the API docs.  It is also not intended as a substitute for good commenting tactics.  And finally, it is a place to put planning documentation (like the stuff Philippe writes), proposals, RFC-type material, and so forth.  But not the roadmap, we use Sourceforge's tracker for that.
 
This is documentation for developers or for people who just want to hack on the code.  It is not intended to replace the automatic API documentation generated by doxygen (we do have a doxyfile, right?), but is intended to supplement those documents with additional information that may not necessarily appear in the API docs.  It is also not intended as a substitute for good commenting tactics.  And finally, it is a place to put planning documentation (like the stuff Philippe writes), proposals, RFC-type material, and so forth.  But not the roadmap, we use Sourceforge's tracker for that.
 +
 +
{{Sections}} <!-- Template:Sections should be at the top of each section -->
  
 
== Stuff That's Current ==
 
== Stuff That's Current ==
Line 22: Line 24:
  
 
* [[Scripted GUI Notes]]
 
* [[Scripted GUI Notes]]
 +
 +
{{Sections}} <!-- Template:Sections should be at the top of each section -->

Revision as of 19:36, 23 October 2005

This is documentation for developers or for people who just want to hack on the code. It is not intended to replace the automatic API documentation generated by doxygen (we do have a doxyfile, right?), but is intended to supplement those documents with additional information that may not necessarily appear in the API docs. It is also not intended as a substitute for good commenting tactics. And finally, it is a place to put planning documentation (like the stuff Philippe writes), proposals, RFC-type material, and so forth. But not the roadmap, we use Sourceforge's tracker for that.


Sections: Installing the Game | Playing the Game | Competition Hub | Server Administration | Extending Armagetron Advanced | Development Docs


Stuff That's Current

Stuff in CVS HEAD

Stuff That's Real but doesn't fit above

Wishlist, or Stuff that's planned

(Might not be planned, but this is it)


Sections: Installing the Game | Playing the Game | Competition Hub | Server Administration | Extending Armagetron Advanced | Development Docs