ThePEG
1.8.0
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
Interface
ClassDocumentation.h
1
// -*- C++ -*-
2
//
3
// ClassDocumentation.h is a part of ThePEG - Toolkit for HEP Event Generation
4
// Copyright (C) 1999-2011 Leif Lonnblad
5
//
6
// ThePEG is licenced under version 2 of the GPL, see COPYING for details.
7
// Please respect the MCnet academic guidelines, see GUIDELINES for details.
8
//
9
#ifndef ThePEG_ClassDocumentation_H
10
#define ThePEG_ClassDocumentation_H
11
// This is the declaration of the ClassDocumentation class.
12
13
#include "ThePEG/Config/ThePEG.h"
14
#include "ClassDocumentation.fh"
15
16
namespace
ThePEG {
17
48
class
ClassDocumentationBase
{
49
50
protected
:
51
63
ClassDocumentationBase
(
string
newDocumentation,
64
string
newModelDescription,
65
string
newModelReferences,
66
const
type_info & newTypeInfo);
67
68
public
:
69
73
virtual
~ClassDocumentationBase
() {}
74
75
public
:
76
80
string
documentation
()
const
{
return
theDocumentation
; }
81
85
string
modelDescription
()
const
{
return
theModelDescription
; }
86
90
string
modelReferences
()
const
{
return
theModelReferences
; }
91
92
private
:
93
97
string
theDocumentation
;
98
102
string
theModelDescription
;
103
107
string
theModelReferences
;
108
109
private
:
110
114
ClassDocumentationBase
();
115
119
ClassDocumentationBase
(
const
ClassDocumentationBase
&);
120
124
ClassDocumentationBase
&
operator=
(
const
ClassDocumentationBase
&);
125
126
};
127
128
159
template
<
typename
T>
160
class
ClassDocumentation
:
public
ClassDocumentationBase
{
161
162
public
:
163
173
ClassDocumentation
(
string
newDocumentation,
174
string
newModelDescription =
""
,
175
string
newModelReferences =
""
)
176
:
ClassDocumentationBase
(newDocumentation, newModelDescription,
177
newModelReferences, typeid(T)) {}
178
179
private
:
180
184
ClassDocumentation
();
185
189
ClassDocumentation
(
const
ClassDocumentation
&);
190
194
ClassDocumentation
&
operator=
(
const
ClassDocumentation
&);
195
196
};
197
198
}
199
200
#endif
/* ThePEG_ClassDocumentation_H */
Generated on Mon Jul 2 2012 16:06:46 for ThePEG by
1.8.1.1