[Insight-developers] Preparation for beta...

[Will Schroeder]

Hi Folks-

I will soon check in the final pass over the documentation in the .h files. Based on what I've seen in these .h files, I'd like to ask developers to do a few things with regards to documentation.

1. Please go back through the documentation in the classes that you created and update it. Some folks have done an absolutely beautiful job of documenting, some have done almost nothing. In particular, make sure that there is a good description of the class and how it's used, etc. I've noticed several cut-and-paste errors where the documentation is completely wrong. Also, the Set/Get and other methods are documented very weakly, if you can put some words about the implications of these methods that would be great.

2. We are really hurting with regard to Set/Get macros. Use them if possible; or if you can't use them, make sure that the methods that you write are implemented properly. It's really important that a Modified() is sent if the value of the ivar changes, but ONLY if it changes. Not doing this results in the pipelines not executing, or executing too often (if Modified() always invoked). These bugs drive users nuts. Please look over your classes and fix as appropriate.

3. The Excel document (Insight/Documentation/ArchitectureAssessment.xls) with indications of problems in most classes is still filled with issues. Please look at it if you have time.

Thanks,
Will