-
Notifications
You must be signed in to change notification settings - Fork 13
/
PackageInfo.dox
79 lines (58 loc) · 3.44 KB
/
PackageInfo.dox
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/**
* \file PackageInfo.dox
*
* \brief General documentation on the Qweak analysis framework
*/
/*------------------------------------------------------------------------*//*!
\mainpage QwAnalysis: the Qweak Analysis Framework
\section welcome Welcome to the Qweak analysis framework documentation
For some information on the doxygen system used to write these pages,
check out the page \subpage doxygen.
\subsection software_overview Components in the analysis software
The Qweak analyzer framework consists of several components:
- \ref QwAnalysis includes general analysis classes used by all packages listed below.
- QwParity includes all instrumentation classes for parity analysis.
- QwGUIMain includes all classes for the analysis GUI front-end.
\subsection software_structure Structure of the analysis software
All subsystems in the Qweak analyzer inherit from a single virtual base
class VQwSubsystem. The next level of detail is implemented as the
base subsystems for parity: VQwSubsystemParity. Finally, these are the base subsystems that
the specific subsystems (such as QwBeamLine or QwDriftChamber)
inherit from, depending on what functionality they need to have. Some
subsystems (such as QwScanner) inherit from both base subsystems.
This global inheritance structure is represented in the following graph:
\dot
digraph example {
node [shape=box, fontname=Helvetica, fontsize=10];
VQwSubsystem [ label="VQwSubsystem" URL="\ref VQwSubsystem"];
VQwSubsystemParity [ label="VQwSubsystemParity" URL="\ref VQwSubsystemParity"];
QwBeamLine [ label="QwBeamLine" URL="\ref QwBeamLine"];
VQwSubsystem -> VQwSubsystemParity;
VQwSubsystemParity -> QwBeamLine;
}
\enddot
The GUI front-end QwGUIMain is relatively independent from the other
components in the Qweak analysis framework.
\section tutorial Tutorial on using the Qweak analysis framework
In this section we will put tutorials for the different components of the
Qweak analysis framework. They are organized according to the two main
types of analysis.
*//*-------------------------------------------------------------------------*/
/*------------------------------------------------------------------------*//*!
\page doxygen Information about the doxygen documentation
The documentation for the Qweak analysis framework is generated with
doxygen (http://www.doxygen.org). General information about the
analysis package is added here by the people who are actually
writing the code. The file that generates this overview is called
"PackageInfo.dox" and can be found in the '$QWANALYSIS' directory.
Specific documentation about the code should be added as comments
to the source code, in the doxygen format. The doxygen configuration
file can be found in the same directory and can be edited to
incorporate additional documentation features if needed. In addition
to the usual source code extensions, the file is currently configured
to include all documented "*.txt", "*.in", and "*.map" files in the
directories starting with and downstream of '$QWANALYSIS'.
If you are new to doxygen and would like a quick reference card to
the tags that can be used in the documentation, take a look at
http://www.digilife.be/quickreferences/QRC/Doxygen%20Quick%20Reference.pdf
*//*-------------------------------------------------------------------------*/