class ThePEG::ClassDocumentation< T >
ClassDocumentation class is used to communicate documetation about an Interfaced class to the Repository.
Similarly to classes inheriting from InterfaceBase, only one static object of the templated ClassDocumentation, which inherits from ClassDocumentationBase, should be created for each Interfaced class. This object will then automatically register itself with the static Repository.
The ClassDocumentation should in the constructor specify three strings with information:
The documentation contains a brief description of the corresponding class which can be displayed by the Repository (or user interfaces derived from it).
The model description contains a very brief description of the model of the process implemented in the step handler, given in the form of a LaTeX \item. This is written to a file after a run by an EventGenerator.
The model references contains possible LaTeX \bibitems corresponding to \cite commands in the model description. This is also written to a file after a run by an EventGenerator.
- See also
Definition at line 160 of file ClassDocumentation.h.