Ticket #15 (closed task: fixed)
The Great Documentation Fixit of 2007
| Reported by: | dave | Owned by: | dave |
|---|---|---|---|
| Priority: | major | Milestone: | NxOS 0.2 |
| Component: | all | Version: | |
| Keywords: | Cc: | sam, jflesch |
Description (last modified by dave) (diff)
After a file reorganization, we desperately need to reorganize our code as well. The APIs are getting too chaotic for my liking, and "public" documentation is sorely lacking.
We need to wrap up the coding style, and then go through all our source code and make it conform to the coding style, one file at a time. The biggest parts of that is splitting out public APIs from intra-kernel APIs (appkernels shouldn't have access to initialization functions if the baseplate initializes, nor should they get access to functions that can damage the hardware if misused (AVR shutdown without first draining the LCD capacitors), and then documenting the crap out of everything in a .h, in doxygen format.
