[Cmb-users] Reference documentation

David Thompson david.thompson at kitware.com
Tue Nov 3 14:05:30 EST 2015


Hi all,

We talked about making CMB and SMTK documentation (especially reference documentation) more consistent and complete today. When you have some time to work on documentation, please take a look at this page:

  http://smtk.readthedocs.org/en/latest/userguide/contributing.html#documentation-style

If you want an example of a properly-documented class, please see

  https://github.com/Kitware/SMTK/blob/master/smtk/model/Entity.h
  https://github.com/Kitware/SMTK/blob/master/smtk/model/Entity.cxx

Not all of the methods are documented (grrr...) but what documentation is there is correct.

	Thanks,
	David


More information about the Cmb-users mailing list