Difference between revisions of "Development Docs"
m (→Docs) |
m (→Docs) |
||
| 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. | ||
| − | + | These are the development docs. This area is intended to be both a place for final documentation that fits, and also something of a scratchpad where developers can document what they just did so the rest of us will know what they did and how to use it. | |
| − | + | == Stuff That's Current == | |
* [[Config Item Purposes]] | * [[Config Item Purposes]] | ||
* [[Project Dependency Structure]] | * [[Project Dependency Structure]] | ||
| − | + | == Stuff in CVS HEAD == | |
* [[Embedded Web Server]] | * [[Embedded Web Server]] | ||
* [[Map/Config Rotation]] | * [[Map/Config Rotation]] | ||
| − | + | == Stuff That's Real but doesn't fit above == | |
* [[Experimental Map Features]] | * [[Experimental Map Features]] | ||
| − | + | == Wishlist, or Stuff that's planned == | |
(Might not be planned, but this is it) | (Might not be planned, but this is it) | ||
* [[Scripted GUI Notes]] | * [[Scripted GUI Notes]] | ||
Revision as of 04:25, 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.
These are the development docs. This area is intended to be both a place for final documentation that fits, and also something of a scratchpad where developers can document what they just did so the rest of us will know what they did and how to use it.
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)
