[Insight-developers] Developer web page / source documentation

[Brad King]

A primitive web page with a few links for insight developers has been put
up at

http://public.kitware.com/Insight/HTMLPrivate/

It is a private developer web page, so you will need your CVS login name
and password to access it. Eventually the page will be much more useful,
but for now it just tells you how to look at and update the source
documentation web page.

This documentation pages are generated from the source by Doxygen, and is
a very useful reference for ITK classes that have been documented.  Every
night the documentation will be re-generated from the CVS repository.  Now
that this is working, I would ask that everyone please update your classes
to have at least a properly documented description.  Even better would be
full method documentation as well.  Remember that this documentation is
done right in the comments in the source.

As an example, I have already finished the full class and method
documentation for the "Cell" and "Container" classes that are used by the
Mesh class.  Doxygen's output for these classes is clean and
useful.  Don't forget that the location of the comments in the source
(especially in class declarations) affects how Doxygen interprets
them.  A general guideline is to put the descriptive comment right before
whatever it documents, and make sure the first sentence in the comment is
a brief summary of the item's purpose.

-Brad King