Daniel Russel wrote:
The IMP doxygen documentation currently throws a lot of class and function names in your face in no particular order (well, alphabetical, but no conceptual order).
Agreed. That's Bret's old documentation for the original IMP classes, most of which is out of date now. So most of it should probably go at some point - certainly I agree that doxygen is a better choice for the API documentation. The manual should ultimately contain more general tutorial-like information.
We can use doxygen modules to give it a nicer structure. This patch adds a module for logging and another for error checking. I think they help a lot. We probably want ones for- Restraints - Optimizers - States - The kernel - Decorators - random helpers - internal stuff
Agreed. I should also add that for really general stuff there is a kernel/src/doc/ directory. Currently the only thing that lives in there is the front page.
Ben
--
http://salilab.org/~ben/
"It is a capital mistake to theorize before one has data."
- Sir Arthur Conan Doyle