Creating Documentation

You can create the documentation for the Digital Material by running doxygen in the DigitalMaterial/doc directory with the command

doxygen doxydm

The Doxygen homepage has a good reference manual, of which Getting Started is very helpful. For a sample use, see the source for ThreadImp.h.

We already have several possible modules a file can be in, including

moleculardynamics

for Molecular Dynamics code.

phasefield

for Phase Field code.

windows

for Windows-only code

dmsystem

for DMSystem code.

A file can be included in several categories at the same time.

We should probably also distinguish GUI interfaces and MD from PhaseField. These are done by using the \defgroup and \ingroup commands in your header files.