Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
ThePEG::ClassDocumentationBase Class Reference
Inheritance diagram for ThePEG::ClassDocumentationBase:
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 ClassDocumentationBase contains three strings with information which are all specified in the constructor:
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.
Constructor & Destructor Documentation
The standard constructor can only be used from subclasses.
The documentation for this class was generated from the following file:
Generated on Thu Jun 28 2018 14:42:04 for ThePEG by 1.8.13