File: ClassDocumentation.h
Description:
The ClassDocumentation class is used to communicate
documetation about an Interfaced class to the
Repository.
See
also:
namespace Pythia7
CLASS
ClassDocumentationBase
Protected members:
ClassDocumentationBase(string newDocumentation,
string newModelDescription,
string newModelReferences,
const type_info & newTypeInfo);
The constructor can only be used from subclasses..
Public members:
inline virtual ~ClassDocumentationBase();
The dtor.
inline string documentation() const;
Return the documentation of the corresponding class.
inline string modelDescription() const;
inline string modelReferences() const;
The string returned from modelDescription() should contain a very
brief description of the model of the process implemented in the
step handler, given in the form of a LaTeX \item. If any LaTeX
\cite reference are given, a corresponding \bibitem should be
returned by modelReference(). E.g. modelDescription() could
return "The XXX model \\cite{XXX} was used for the YYY pocess",
and modelReferences() should then return something like
"\\bibitem{XXX} J.~Doe, \\textit{Journal} \\textbf{volume} (year)
page." Note the double-slash to get a single slash, and that
modelReferences() must begin with a "\\bibitem".
Private members:
string theDocumentation;
The documentation of the corresponding class.
string theModelDescription;
string theModelReferences;
A (LaTeX) sentence describing the implemented model (if any). If
any \\cite references are given, the corresponding citation
should be listed in theModelReferences.
ClassDocumentationBase();
ClassDocumentationBase(const ClassDocumentationBase &);
ClassDocumentationBase & operator=(const ClassDocumentationBase &);
Private and unimplemented.
template <typename T>
CLASS
ClassDocumentation:
Base class:
Public members:
inline ClassDocumentation(string newDocumentation,
string newModelDescription = "",
string newModelReferences = "");
inline virtual ~ClassDocumentation();
Standard ctors and dtor.
Private members:
ClassDocumentation();
ClassDocumentation(const ClassDocumentation &);
ClassDocumentation & operator=(const ClassDocumentation &);
Private and unimplemented.
DEFINED MACROS
PYTHIA7_ClassDocumentation_H
INCLUDED FILES
Pythia7/Config/Pythia7.h
ClassDocumentation.fh
ClassDocumentation.icc