Difference between revisions of "Development Docs"

(Added Project Dependency Structure)
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.
  
== Configuration ==
+
== Docs ==
  
[[Config Item Purposes]]
+
* [[Config Item Purposes]]
 +
* [[Project Dependency Structure]]

Revision as of 01:39, 22 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.

Docs