Import Geant4 9.6.0 source tree

This commit is contained in:
Gabriele Cosmo
2016-06-09 17:01:34 +02:00
parent b1eb5424d2
commit e2d2f9810a
10384 changed files with 698580 additions and 628834 deletions
+25
View File
@@ -0,0 +1,25 @@
$Id$
///\file ".README.HowToNavigate"
///\brief Examples How To Navigate README page
/*! \page README_HowToNavigate How to navigate in the examples documentation
The examples documentation is composed from a <b> "global" documentation </b> including all examples with classes which has unique names (eg. A01DetectorConstruction etc.) and from <b> "standalone" documentations </b> for examples with classes which names are not not unique (DetectorConstruction etc.).
\section HowToNavigate_sec1 Global documentation
The lists of <a href="pages.html"> "Related Pages" </a> and <a href="modules.html"> "Modules"</a> in the global documentation include the README pages for all examples categories and examples with both unique class names and generic ones. The lists <a href="namespaces.html"> "Namespaces" </a>, <a href="classes.html"> "Classes" </a> and <a href="files.html"> "Files" </a> include only the examples with unique class names.
That's why the README pages for the examples with a standalone documentation generated in the global documentation do not contain links to their classes
(one cannot click on a class name here to get the class documentation). See eg. \ref ExampleTestEm1.
\section HowToNavigate_sec2 Standalone documentations
The links from "global" documentation to the examples "standalone" documentation are available in the list of <a href="modules.html"> "Modules"</a>. When selecting eg. "TestEm1" here, you will be directed to <a href="../html_TestEm1/html/index.html"> the main page </a> of its standalone documentation. When selecting then <a href="../html_TestEm1/html/ExampleTestEm1.html"> "Example TestEm1" </a> from the <a href="../html_TestEm1/html/pages.html"> "Related Pages" </a> list here (there is only one page in the list) you will get the example documentation with hyperlinks to the classes etc.
All the lists in the examples "standalone" documentation include only the concerned example and eventually the classes shared with another examples or the classes from <a href="Examples_common.html"> common </a> if they are used in the example.
This organization was necessary as Doxygen does not support the classes with the same names in one system.
*/
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,9 @@
K 13
svn:eol-style
V 2
LF
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,13 @@
K 13
svn:eol-style
V 2
LF
K 14
svn:executable
V 1
*
K 12
svn:keywords
V 2
Id
END
@@ -0,0 +1,25 @@
$Id$
///\file ".README.HowToNavigate"
///\brief Examples How To Navigate README page
/*! \page README_HowToNavigate How to navigate in the examples documentation
The examples documentation is composed from a <b> "global" documentation </b> including all examples with classes which has unique names (eg. A01DetectorConstruction etc.) and from <b> "standalone" documentations </b> for examples with classes which names are not not unique (DetectorConstruction etc.).
\section HowToNavigate_sec1 Global documentation
The lists of <a href="pages.html"> "Related Pages" </a> and <a href="modules.html"> "Modules"</a> in the global documentation include the README pages for all examples categories and examples with both unique class names and generic ones. The lists <a href="namespaces.html"> "Namespaces" </a>, <a href="classes.html"> "Classes" </a> and <a href="files.html"> "Files" </a> include only the examples with unique class names.
That's why the README pages for the examples with a standalone documentation generated in the global documentation do not contain links to their classes
(one cannot click on a class name here to get the class documentation). See eg. \ref ExampleTestEm1.
\section HowToNavigate_sec2 Standalone documentations
The links from "global" documentation to the examples "standalone" documentation are available in the list of <a href="modules.html"> "Modules"</a>. When selecting eg. "TestEm1" here, you will be directed to <a href="../html_TestEm1/html/index.html"> the main page </a> of its standalone documentation. When selecting then <a href="../html_TestEm1/html/ExampleTestEm1.html"> "Example TestEm1" </a> from the <a href="../html_TestEm1/html/pages.html"> "Related Pages" </a> list here (there is only one page in the list) you will get the example documentation with hyperlinks to the classes etc.
All the lists in the examples "standalone" documentation include only the concerned example and eventually the classes shared with another examples or the classes from <a href="Examples_common.html"> common </a> if they are used in the example.
This organization was necessary as Doxygen does not support the classes with the same names in one system.
*/
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,48 @@
// $Id$
/// \file Doxymain.h
/// \brief The main page for Geant4 Examples code documenation
/*! \mainpage Geant4 Examples
This module collects four sets of user examples aimed to demonstrate to
the user how to make correct use of the GEANT4 toolkit by implementing
in a correct way those user-classes which the user is supposed to
customize in order to define his/her own simulation setup.
The <b>"novice"</b> set of examples is oriented to novice users and covering all
possible general use-cases typical of an "application"-oriented kind of
development. As several examples in this "novice" set became too complicated,
a new <b>"basic"</b> set, covering the most typical use-cases of a Geant4 application
with keeping simplicity and ease of use, is provided and is going to replace
the "novice" set in future.
An <b>"extended"</b> set of examples require some additional
libraries besides of Geant4. This set covers some specific use cases
for actual detector simulation. An <b>"advanced"</b> set of examples covers
the use-cases typical of a "toolkit"-oriented kind of development,
where real complete applications for different simulation studies are
provided; may require additional third party products to be built.
Most of the examples can be run both in interactive and batch mode, and
input macro files (*.in) and reference output files (*.out) are provided.
Basic, novice and most of the extended examples are considered part of the
system testing suite for validation of the official releases of the
GEANT4 toolkit. Basic, novice and some of the extended and advanced
examples are also used as "acceptance"-tests for the release process.
See more on each examples category pages:
- \ref README_basic
- \ref README_extended
- <a href="http://geant4advancedexampleswg.wikispaces.com/ExamplesDocumentation">
Advanced Examples </a>
And more on what is common for all examples:
- \ref README_HowToRun
- \ref README_HowToNavigate
*/
@@ -0,0 +1,91 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_analysis.h
/// \brief The page that defines the extended/analysis examples modules
/** @defgroup extended_analysis analysis
* Extended examples analysis classes
* @{
*/
/** @defgroup extended_analysis_A01 A01
* Analysis example A01
* @ingroup extended_analysis
* @{
*/
class A01AnalysisManager {};
class A01CellParameterisation {};
class A01DetectorConstMessenger {};
class A01DetectorConstruction {};
class A01DriftChamber {};
class A01DriftChamberHit {};
class A01EmCalorimeter {};
class A01EmCalorimeterHit {};
class A01EMPhysics {};
class A01EventAction {};
class A01EventActionMessenger {};
class A01GeneralPhysics {};
class A01HadCalorimeter {};
class A01HadCalorimeterHit {};
class A01HadronPhysics {};
class A01Hodoscope {};
class A01HodoscopeHit {};
class A01IonPhysics {};
class A01MagneticField {};
class A01MagneticFieldMessenger {};
class A01MuonPhysics {};
class A01PhysicsList {};
class A01PrimaryGeneratorAction {};
class A01PrimaryGeneratorMessenger {};
/** @} */
/** @defgroup extended_analysis_shared shared
* The shared analysis classes have their
* <a href="../html_analysis_shared/html/index.html">standalone documentation </a>
* @ingroup extended_analysis
* @{
*/
/** @} */
/** @defgroup extended_analysis_AnaEx01 AnaEx01
* Analysis AnaEx01 example has its
* <a href="../html_AnaEx01/html/index.html">standalone documentation </a>
* @ingroup extended_analysis
* @{
*/
/** @} */
/** @defgroup extended_analysis_AnaEx02 AnaEx02
* Analysis AnaEx02 example has its
* <a href="../html_AnaEx02/html/index.html">standalone documentation </a>
* @ingroup extended_analysis
* @{
*/
/** @} */
/** @defgroup extended_analysis_AnaEx03 AnaEx03
* Analysis AnaEx03 example has its
* <a href="../html_AnaEx03/html/index.html">standalone documentation </a>
* @ingroup extended_analysis
* @{
*/
/** @} */
/** @defgroup extended_analysis_N03Con N03Con
* Analysis AnaEx03 example has its
* <a href="../html_N03Con/html/index.html">standalone documentation </a>
* @ingroup extended_analysis
* @{
*/
/** @} */
/** @} */
@@ -0,0 +1,152 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_basic.h
/// \brief The page that defines the basic examples modules
/** @defgroup basic basic
* Basic examples classes
* @{
*/
/** @} */
/** @defgroup B1 B1
* Example B1
* @ingroup basic
* @{
*/
class B1DetectorConstruction{};
class B1EventAction{};
class B1PrimaryGeneratorAction{};
class B1RunAction{};
class B1SteppingAction{};
/** @} */
/** @defgroup B2 B2
* Example B2
* @ingroup basic
* @{
*/
/** @defgroup B2a B2a
* Example B2a
* @ingroup B2
* @{
*/
class B2aDetectorConstruction{};
class B2aDetectorMessenger{};
class B2EventAction{};
class B2MagneticField{};
class B2PrimaryGeneratorAction{};
class B2RunAction{};
class B2TrackerHit{};
class B2TrackerSD{};
/** @} */
/** @defgroup B2b B2b
* Example B2b
* @ingroup B2
* @{
*/
class B2bChamberParameterisation{};
class B2bDetectorConstruction{};
class B2bDetectorMessenger{};
class B2EventAction{};
class B2MagneticField{};
class B2PrimaryGeneratorAction{};
class B2RunAction{};
class B2TrackerHit{};
class B2TrackerSD{};
/** @} */
/** @} */
/** @defgroup B3 B3
* Example B3
* @ingroup basic
* @{
*/
class B3DetectorConstruction{};
class B3EventAction{};
class B3PhysicsList{};
class B3PrimaryGeneratorAction{};
class B3StackingAction{};
class B3RunAction{};
/** @} */
/** @defgroup B4 B4
* Example B4
* @ingroup basic
* @{
*/
/** @} */
/** @defgroup B4a B4a
* Example B4a
* @ingroup B4
* @{
*/
class B4aEventAction{};
class B4aSteppingAction{};
class B4DetectorConstruction{};
class B4PrimaryGeneratorAction{};
class B4RunAction{};
/** @} */
/** @} */
/** @defgroup B4b B4b
* Example B4b
* @ingroup B4
* @{
*/
class B4bEventAction{};
class B4bRunData{};
class B4bSteppingAction{};
class B4DetectorConstruction{};
class B4PrimaryGeneratorAction{};
class B4RunAction{};
/** @} */
/** @defgroup B4c B4c
* Example B4c
* @ingroup B4
* @{
*/
class B4cDetectorConstruction{};
class B4cCalorHit{};
class B4cCalorimeterSD{};
class B4cEventAction{};
class B4PrimaryGeneratorAction{};
class B4RunAction{};
/** @} */
/** @} */
/** @defgroup B4d B4d
* Example B4d
* @ingroup B4
* @{
*/
class B4dDetectorConstruction{};
class B4dEventAction{};
class B4PrimaryGeneratorAction{};
class B4RunAction{};
/** @} */
/** @} */
@@ -0,0 +1,76 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_biasing.h
/// \brief The page that defines the extended/biasing examples modules
/** @defgroup extended_biasing biasing
* Extended examples biasing classes
* @{
*/
/** @defgroup extended_biasing_B01 B01
* Biasing example B01
* @ingroup extended_biasing
* @{
*/
class B01DetectorConstruction {};
class B01PhysicsList {};
class B01PrimaryGeneratorAction {};
class B01RunAction {};
class B01Run {};
class B01ScoreTable {};
/** @} */
/** @defgroup extended_biasing_B02 B02
* Biasing example B02
* @ingroup extended_biasing
* @{
*/
class B02CellScorer {};
class B02CellScorerStore {};
class B02DetectorConstruction {};
class B02ImportanceDetectorConstruction {};
class B02PhysicsList {};
class B02PrimaryGeneratorAction {};
class B02PSScoringDetectorConstruction {};
class B02PVolumeStore {};
class B02RunAction {};
class B02Run {};
class B02ScoreTable {};
class B02ScoringDetectorConstruction {};
/** @} */
/** @defgroup extended_biasing_ReverseMC01 ReverseMC01
* Biasing example ReverseMC01
* @ingroup extended_biasing
* @{
*/
class G4AdjointPhysicsList {};
class G4AdjointPhysicsMessenger {};
class Histo1DVar {};
class Histo2DVar {};
class Histograms {};
class RMC01AdjointEventAction {};
class RMC01AnalysisManager {};
class RMC01AnalysisManagerMessenger {};
class RMC01DetectorConstruction {};
class RMC01DetectorMessenger {};
class RMC01DoubleWithWeightHit {};
class RMC01EventAction {};
class RMC01PrimaryGeneratorAction {};
class RMC01RunAction {};
class RMC01SD {};
enum side {};
class VariableLengthPartition {};
/** @} */
/** @} */
@@ -0,0 +1,70 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_common.h
/// \brief The page that defines the extended/common classes modules
/** @defgroup extended_common common
* Extended examples common classes
* @{
*/
/** @defgroup extended_common_analysis analysis
* The analysis classes of generic use in examples
* @ingroup extended_common
* @{
*/
class ExG4HbookAnalysisManager{};
/** @} */
/** @defgroup extended_common_detectorConstruction detectorConstruction
* The detector construction classes of generic use in examples
* @ingroup extended_common
* @{
*/
class ExG4DetectorConstruction01{};
class ExG4DetectorConstruction01Messenger{};
class ExG4DetectorConstruction02{};
class ExG4DetectorConstruction02Messenger{};
/** @} */
/** @defgroup extended_common_physicsList physicsList
* The primary generator classes of generic use in examples
* @ingroup extended_common
* @{
*/
class ExG4PhysicsList00{};
/** @} */
/** @defgroup extended_common_primaryGenerator primaryGenerator
* The primary generator classes of generic use in examples
* @ingroup extended_common
* @{
*/
class ExG4PrimaryGeneratorAction01{};
class ExG4PrimaryGeneratorAction02{};
/** @} */
/** @defgroup extended_common_userActions userActions
* The user action classes of generic use in examples
* @ingroup extended_common
* @{
*/
class ExG4EventAction01{};
class ExG4EventAction01Messenger{};
class ExG4RunAction01{};
class ExG4RunAction01Messenger{};
/** @} */
/** @} */
@@ -0,0 +1,185 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_electromagnetic.h
/// \brief The page that defines the extended/electromagnetic examples modules
/** @defgroup extended_electromagnetic electromagnetic
* Extended examples electromagnetic classes
* @{
*/
/** @defgroup extended_electromagnetic_TestEm0 TestEm0
* The TestEm0 electromagnetic classes have their
* <a href="../html_TestEm0/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm1 TestEm1
* The TestEm1 electromagnetic classes have their
* <a href="../html_TestEm1/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm2 TestEm2
* The TestEm2 electromagnetic classes have their
* <a href="../html_TestEm2/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm3 TestEm3
* The TestEm3 electromagnetic classes have their
* <a href="../html_TestEm3/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm4 TestEm4
* The TestEm4 electromagnetic classes have their
* <a href="../html_TestEm4/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm5 TestEm5
* The TestEm5 electromagnetic classes have their
* <a href="../html_TestEm5/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm6 TestEm6
* The TestEm6 electromagnetic classes have their
* <a href="../html_TestEm6/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm7 TestEm7
* The TestEm7 electromagnetic classes have their
* <a href="../html_TestEm7/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm8 TestEm8
* The TestEm8 electromagnetic classes have their
* <a href="../html_TestEm8/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm9 TestEm9
* The TestEm9 electromagnetic classes have their
* <a href="../html_TestEm9/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm10 TestEm10
* The TestEm10 electromagnetic classes have their
* <a href="../html_TestEm10/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm11 TestEm11
* The TestEm11 electromagnetic classes have their
* <a href="../html_TestEm11/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm12 TestEm12
* The TestEm12 electromagnetic classes have their
* <a href="../html_TestEm12/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm13 TestEm13
* The TestEm13 electromagnetic classes have their
* <a href="../html_TestEm13/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm14 TestEm14
* The TestEm14 electromagnetic classes have their
* <a href="../html_TestEm14/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm15 TestEm15
* The TestEm15 electromagnetic classes have their
* <a href="../html_TestEm15/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm16 TestEm16
* The TestEm16 electromagnetic classes have their
* <a href="../html_TestEm16/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm17 TestEm17
* The TestEm17 electromagnetic classes have their
* <a href="../html_TestEm17/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm18 TestEm18
* The TestEm18 electromagnetic classes have their
* <a href="../html_TestEm18/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @} */
@@ -0,0 +1,18 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_errorpropagation.h
/// \brief The page that defines the extended/errorpropagation examples modules
/** @defgroup extended_errorpropagation errorpropagation
* Errorpropagation example
* @ingroup extended
* @{
*/
class ExErrorDetectorConstruction {};
class ExErrorDetectorMessenger {};
class ExErrorMagneticField {};
/** @} */
@@ -0,0 +1,135 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_eventgenerator.h
/// \brief The page that defines the extended/eventgenerator examples modules
/** @defgroup extended_eventgenerator eventgenerator
* Extended examples eventgenerator classes
* @{
*/
/** @defgroup extended_eventgenerator_exgps exgps
* Eventgenerator example exgps
* @ingroup extended_eventgenerator
* @{
*/
class exGPSAnalysisManager {};
class exGPSAnalysisMessenger {};
class exGPSEventAction {};
class exGPSEventActionMessenger {};
class exGPSGeometryConstruction {};
class exGPSPhysicsList {};
class exGPSPrimaryGeneratorAction {};
class exGPSRunAction {};
/** @} */
/** @defgroup extended_eventgenerator_HepMC HepMC
* Extended examples eventgenerator/HepMC
* @ingroup extended_eventgenerator
* @{
*/
/** @defgroup extended_eventgenerator_HepMC_HepMCEx01 HepMCEx01
* Eventgenerator HepMC example HepMCEx01
* @ingroup extended_eventgenerator_HepMC
* @{
*/
class ExN04CalorimeterHit {};
class ExN04CalorimeterParametrisation {};
class ExN04CalorimeterROGeometry {};
class ExN04CalorimeterSD {};
class ExN04DetectorConstruction {};
class ExN04DetectorParameterDef {};
class ExN04DummySD {};
class ExN04EventAction {};
class ExN04Field {};
class ExN04MuonHit {};
class ExN04MuonSD {};
class ExN04PrimaryGeneratorAction {};
class ExN04PrimaryGeneratorMessenger {};
class ExN04RunAction {};
class ExN04StackingAction {};
class ExN04StackingActionMessenger {};
class ExN04SteppingAction {};
class ExN04SteppingVerbose {};
class ExN04TrackerHit {};
class ExN04TrackerParametrisation {};
class ExN04TrackerSD {};
class ExN04TrackingAction {};
class HepMCG4AsciiReader {};
class HepMCG4AsciiReaderMessenger {};
class HepMCG4Interface {};
class HepMCG4PythiaInterface {};
class HepMCG4PythiaMessenger {};
/** @} */
/** @defgroup extended_eventgenerator_HepMC_HepMCEx02 HepMCEx02
* Eventgenerator HepMC example HepMCEx02
* @ingroup extended_eventgenerator_HepMC
* @{
*/
class H02DetectorConstruction {};
class H02EventAction {};
class H02Field {};
class H02MuonHit {};
class H02MuonSD {};
class H02PrimaryGeneratorAction {};
class H02PrimaryGeneratorMessenger {};
class H02SteppingAction {};
class HepMCG4AsciiReader {};
class HepMCG4AsciiReaderMessenger {};
class HepMCG4Interface {};
class HepMCG4PythiaInterface {};
class HepMCG4PythiaMessenger {};
/** @} */
/** @defgroup extended_eventgenerator_HepMC_MCTruth MCTruth
* Eventgenerator HepMC example MCTruth
* @ingroup extended_eventgenerator_HepMC
* @{
*/
class MCTruthConfig {};
class MCTruthEventAction {};
class MCTruthManager {};
class MCTruthTrackInformation {};
class MCTruthTrackingAction {};
/** @} */
/** @} */
/** @defgroup extended_eventgenerator_particleGun particleGun
* Eventgenerator example particleGun has its
* <a href="../html_particleGun/html/index.html">standalone documentation </a>
* @ingroup extended_eventgenerator
* @{
*/
/** @} */
/** @defgroup extended_eventgenerator_pythia_decayer6 pythia_decayer6
* Eventgenerator example pythia_decayer6
* @ingroup extended_eventgenerator
* @{
*/
enum EDecayType {};
class G4Pythia6Decayer {};
class G4Pythia6DecayerMessenger {};
class P6DExtDecayerPhysics {};
class P6DPhysicsList {};
class Pythia6 {};
/** @} */
/** @} */
@@ -0,0 +1,47 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_exoticphysics.h
/// \brief The page that defines the extended/exoticphysics examples modules
/** @defgroup extended_exoticphysics exoticphysics
* Extended examples eventgenerator classes
* @{
*/
/** @defgroup extended_exoticphysics_monopole monopole
* Exoticphysics monopole example has its
* <a href="../html_monopole/html/index.html">standalone documentation </a>
* @ingroup extended_exoticphysics
* @{
*/
/** @} */
/** @defgroup extended_exoticphysics_phonon phonon
* Exotic physics example phonon
* @ingroup extended_exoticphysics
* @{
*/
class XAlminumElectrodeHit {};
class XAlminumElectrodeSensitivity {};
class XDetectorConstruction {};
class XLatticeManager3 {};
class XLogicalLattice {};
class XLPhonon {};
class XPhononDownconversionProcess {};
class XPhononReflectionProcess {};
class XPhononScatteringProcess {};
class XPhononStackingAction {};
class XPhononTrackInformation {};
class XPhysicalLattice {};
class XPhysicsList {};
class XPrimaryGeneratorAction {};
class XTPhononFast {};
class XTPhononSlow {};
/** @} */
/** @} */
@@ -0,0 +1,170 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_field.h
/// \brief The page that defines the extended/field examples modules
/** @defgroup extended_field field
* Extended examples field classes
* @{
*/
/** @defgroup extended_field_BlineTracer BlineTracer
* Field example BlineTracer
* @ingroup extended_field
* @{
*/
class G4BlineEquation {};
class G4BlineEventAction {};
class G4BlinePrimaryGeneratorAction {};
class G4BlineSteppingAction {};
class G4BlineTracer {};
class G4BlineTracerMessenger {};
/** @} */
/** @defgroup extended_field_field01 field01
* Field example field01
* @{
*/
class F01CalorHit {};
class F01CalorimeterSD {};
class F01DetectorConstruction {};
class F01DetectorMessenger {};
class F01EventAction {};
class F01EventActionMessenger {};
class F01FieldMessenger {};
class F01FieldSetup {};
class F01PhysicsList {};
class F01PhysicsListMessenger {};
class F01PrimaryGeneratorAction {};
class F01PrimaryGeneratorMessenger {};
class F01RunAction {};
class F01RunMessenger {};
class F01StepCut {};
class F01SteppingAction {};
class F01SteppingMessenger {};
class F01SteppingVerbose {};
/** @} */
/** @defgroup extended_field_field02 field02
* Field example field02
* @{
*/
class F02CalorHit {};
class F02CalorimeterSD {};
class F02DetectorConstruction {};
class F02DetectorMessenger {};
class F02ElectricFieldSetup {};
class F02EventAction {};
class F02EventActionMessenger {};
class F02FieldMessenger {};
class F02PhysicsList {};
class F02PhysicsListMessenger {};
class F02PrimaryGeneratorAction {};
class F02PrimaryGeneratorMessenger {};
class F02RunAction {};
class F02RunMessenger {};
class F02StepCut {};
class F02SteppingAction {};
class F02SteppingMessenger {};
class F02SteppingVerbose {};
/** @} */
/** @defgroup extended_field_field03 field03
* Field example field03
* @{
*/
class F03CalorHit {};
class F03CalorimeterSD {};
class F03DetectorConstruction {};
class F03DetectorMessenger {};
class F03EventAction {};
class F03EventActionMessenger {};
class F03FieldMessenger {};
class F03FieldSetup {};
class F03PhysicsList {};
class F03PhysicsListMessenger {};
class F03PrimaryGeneratorAction {};
class F03PrimaryGeneratorMessenger {};
class F03RunAction {};
class F03RunMessenger {};
class F03StepCut {};
class F03SteppingAction {};
class F03SteppingMessenger {};
class F03SteppingVerbose {};
/** @} */
/** @defgroup extended_field_field04 field04
* Field example field04
* @{
*/
class F04DetectorConstruction {};
class F04DetectorMessenger {};
class F04ElementField {};
class F04EventAction {};
class F04EventActionMessenger {};
class F04ExtraPhysics {};
class F04FieldMessenger {};
class F04FocusSolenoid {};
class F04GlobalField {};
class F04Materials {};
class F04OpticalPhysics {};
class F04PhysicsList {};
class F04PhysicsListMessenger {};
class F04PrimaryGeneratorAction {};
class F04PrimaryGeneratorMessenger {};
class F04RunAction {};
class F04RunActionMessenger {};
class F04SimpleSolenoid {};
class F04StackingAction {};
class F04StepMax {};
class F04SteppingAction {};
class F04SteppingActionMessenger {};
class F04SteppingVerbose {};
class F04TrackingAction {};
class F04Trajectory {};
class F04TrajectoryPoint {};
class F04UserTrackInformation {};
/** @} */
/** @defgroup extended_field_field05 field05
* Field example field05
* @{
*/
class F05DetectorConstruction {};
class F05ExtraPhysics {};
class F05Field {};
class F05PhysicsList {};
class F05PrimaryGeneratorAction {};
class F05SteppingAction {};
/** @} */
/** @defgroup extended_field_field06 field06
* Field example field06
* @{
*/
class F06DetectorConstruction {};
class F06EventAction {};
class F06EventActionMessenger {};
class F06ExtraPhysics {};
class F06Field {};
class F06PhysicsList {};
class F06PrimaryGeneratorAction {};
/** @} */
/** @} */
@@ -0,0 +1,22 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_g3tog4.h
/// \brief The page that defines the extended/g3tog4 examples modules
/** @defgroup extended_g3tog4 g3tog4
* Extended examples g3tog4 classes
* @{
*/
/** @defgroup extended_g3tog4_clGeometry clGeometry
* g3tog4 example clGeometry
* @{
*/
class G3toG4DetectorConstruction {};
/** @} */
/** @} */
@@ -0,0 +1,43 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_geometry.h
/// \brief The page that defines the extended/geometry examples modules
/** @defgroup extended_geometry geometry
* Extended examples geometry classes
* @{
*/
/** @defgroup extended_geometry_olap olap
* Geometry example olap
* @{
*/
class G4GeoNav {};
class OlapDetConstr {};
class OlapEventAction {};
class OlapGenerator {};
class OlapLogManager {};
class OlapManager {};
class OlapManagerMessenger {};
class OlapNotify {};
class OlapPhysicsList {};
class OlapRunAction {};
class OlapSteppingAction {};
class RandomDetector {};
class SolidAnalyser {};
class tree {};
/** @} */
/** @defgroup extended_geometry_transforms transforms
* Geometry example transforms has its
* <a href="../html_transforms/html/index.html">standalone documentation </a>
* @{
*/
/** @} */
/** @} */
@@ -0,0 +1,49 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_hadronic.h
/// \brief The page that defines the extended/hadronic examples modules
/** @defgroup extended_hadronic hadronic
* Extended examples hadronic classes
* @{
*/
/** @defgroup extended_hadronic_Hadr00 Hadr00
* The shared hadronic classes have their
* <a href="../html_Hadr00/html/index.html">standalone documentation </a>
* @ingroup extended_hadronic
* @{
*/
/** @} */
/** @defgroup extended_hadronic_Hadr01 Hadr01
* The shared hadronic classes have their
* <a href="../html_Hadr01/html/index.html">standalone documentation </a>
* @ingroup extended_hadronic
* @{
*/
/** @} */
/** @defgroup extended_hadronic_Hadr02 Hadr02
* The shared hadronic classes have their
* <a href="../html_Hadr02/html/index.html">standalone documentation </a>
* @ingroup extended_hadronic
* @{
*/
/** @} */
/** @defgroup extended_hadronic_Hadr03 Hadr03
* The shared hadronic classes have their
* <a href="../html_Hadr03/html/index.html">standalone documentation </a>
* @ingroup extended_hadronic
* @{
*/
/** @} */
/** @} */
@@ -0,0 +1,86 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_medical.h
/// \brief The page that defines the extended/medical examples modules
/** @defgroup extended_medical medical
* Extended medical examples classes
* @{
*/
/** @defgroup extended_medical_DICOM DICOM
* Medical example DICOM
* @ingroup extended_medical
* @{
*/
class DicomDetectorConstruction {};
class DicomEventAction {};
class DicomHandler {};
class DicomIntersectVolume {};
class DicomNestedParamDetectorConstruction {};
class DicomNestedPhantomParameterisation {};
class DicomPartialDetectorConstruction {};
class DicomPhantomParameterisationColour {};
class DicomPhantomZSliceHeader {};
class DicomPhysicsList {};
class DicomPrimaryGeneratorAction {};
class DicomRegularDetectorConstruction {};
class DicomRunAction {};
class DicomRun {};
class NestedParamDicomDetectorConstruction {};
class RegularDicomDetectorConstruction {};
/** @} */
/** @} */
/** @defgroup extended_medical_electronScattering electronScattering
* Medical electronScattering example has its
* <a href="../html_electronScattering/html/index.html">standalone documentation </a>
* @ingroup extended_medical
* @{
*/
/** @} */
/** @defgroup extended_medical_electronScattering2 electronScattering2
* Medical electronScattering2 example has its
* <a href="../html_electronScattering2/html/index.html">standalone documentation </a>
* @ingroup extended_medical
* @{
*/
/** @} */
/** @defgroup extended_medical_fanoCavity fanoCavity
* Medical fanoCavity example has its
* <a href="../html_fanoCavity/html/index.html">standalone documentation </a>
* @ingroup extended_medical
* @{
*/
/** @} */
/** @defgroup extended_medical_fanoCavity2 fanoCavity2
* Medical fanoCavity2 example has its
* <a href="../html_fanoCavity2/html/index.html">standalone documentation </a>
* @ingroup extended_medical
* @{
*/
/** @} */
/** @defgroup extended_medical_GammaTherapy GammaTherapy
* Medical GammaTherapy example has its
* <a href="../html_GammaTherapy/html/index.html">standalone documentation </a>
* @ingroup extended_medical
* @{
*/
/** @} */
/** @} */
@@ -0,0 +1,70 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_new.h
/// \brief The page that defines the extended/new examples modules
/** @defgroup extended_new new
* New extended examples classes
* @{
*/
/** @defgroup extended_new_decay decay
* The extended/decay classes
* @ingroup extended_new
* @{
*/
/** @defgroup extended_new_decay_pythia6Decayer pythia6Decayer
* The Example pythia6Decayer classes
* @ingroup extended_new_decay
* @{
*/
class G4Pythia6Decayer{};
class G4Pythia6DecayerMessenger{};
class P6DExtDecayerPhysics{};
class P6DPhysicsList{};
class Pythia6{};
/** @} */
/** @} */
/** @defgroup extended_new_geometry geometry
* The extended/geometry classes
* @ingroup extended_new
* @{
*/
/** @defgroup extended_new_geometry_transform transform
* The Example transform classes
* @ingroup extended_new_geometry
* @{
*/
class TrDetectorConstruction{};
class TrDetectorConstructionMessenger{};
/** @} */
/** @} */
/** @defgroup extended_new_materials materials
* The extended/materials classes
* @ingroup extended_new
* @{
*/
/** @defgroup extended_new_materials_mat01 mat01
* The Example mat01 classes
* @ingroup extended_new_materials
* @{
*/
class Mat01DetectorConstruction{};
/** @} */
/** @} */
/** @} */
@@ -0,0 +1,81 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_optical.h
/// \brief The page that defines the extended/optical examples modules
/** @defgroup extended_optical optical
* Extended optical examples classes
* @{
*/
/** @defgroup extended_optical_LXe LXe
* Optical example LXe
* @ingroup extended_optical
* @{
*/
class LXeDetectorConstruction {};
class LXeDetectorMessenger {};
class LXeEMPhysics {};
class LXeEventAction {};
class LXeEventMessenger {};
class LXeGeneralPhysics {};
class LXeMainVolume {};
class LXeMuonPhysics {};
class LXePhysicsList {};
class LXePMTHit {};
class LXePMTSD {};
class LXePrimaryGeneratorAction {};
class LXeRunAction {};
class LXeScintHit {};
class LXeScintSD {};
class LXeStackingAction {};
class LXeSteppingAction {};
class LXeSteppingMessenger {};
class LXeSteppingVerbose {};
class LXeTrackingAction {};
class LXeTrajectory {};
class LXeUserEventInformation {};
class LXeUserTrackInformation {};
class LXeWLSFiber {};
class LXeWLSSlab {};
class RecorderBase {};
/** @} */
/** @defgroup extended_optical_wls wls
* Optical example wls
* @ingroup extended_optical
* @{
*/
class WLSDetectorConstruction {};
class WLSDetectorMessenger {};
class WLSEventAction {};
class WLSEventActionMessenger {};
class WLSExtraPhysics {};
class WLSMaterials {};
class WLSOpticalPhysics {};
class WLSPhotonDetHit {};
class WLSPhotonDetSD {};
class WLSPhysicsList {};
class WLSPhysicsListMessenger {};
class WLSPrimaryGeneratorAction {};
class WLSPrimaryGeneratorMessenger {};
class WLSRunAction {};
class WLSRunActionMessenger {};
class WLSStackingAction {};
class WLSStepMax {};
class WLSSteppingAction {};
class WLSSteppingActionMessenger {};
class WLSSteppingVerbose {};
class WLSTrackingAction {};
class WLSTrajectory {};
class WLSTrajectoryPoint {};
class WLSUserTrackInformation {};
/** @} */
/** @} */
@@ -0,0 +1,58 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_parallel.h
/// \brief The page that defines the extended/parallel examples modules
/** @defgroup extended_parallel parallel
* Extended examples parallel classes
* @{
*/
/** @defgroup extended_parallel_MPI MPI
* Extended examples parallel MPI classes
* @{
*/
/** @defgroup extended_parallel_MPI_exMPI01 exMPI01
* Parallel MPI exMPI01 example has its
* <a href="../html_exMPI01/html/index.html">standalone documentation </a>
* @ingroup extended_parallel_MPI
* @{
*/
/** @} */
/** @defgroup extended_parallel_MPI_exMPI02 exMPI02
* Parallel MPI exMPI02 example has its
* <a href="../html_exMPI02/html/index.html">standalone documentation </a>
* @ingroup extended_parallel_MPI
* @{
*/
/** @} */
/** @} */
/** @defgroup extended_parallel_ParN02 ParN02
* Parallel ParN02 example has its
* <a href="../html_ParN02/html/index.html">standalone documentation </a>
* @ingroup extended_parallel
* @{
*/
/** @} */
/** @defgroup extended_parallel_ParN04 ParN04
* Parallel ParN04 example has its
* <a href="../html_ParN04/html/index.html">standalone documentation </a>
* @ingroup extended_parallel
* @{
*/
/** @} */
/** @} */
@@ -0,0 +1,30 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_parameterisations.h
/// \brief The page that defines the extended/parameterisations examples modules
/** @defgroup extended_parameterisations parameterisations
* Extended examples parameterisations classes
* @{
*/
/** @defgroup extended_parameterisations_gflash gflash
* parameterisations example gflash
* @{
*/
class ExGflashDetectorConstruction {};
class ExGflashEventAction {};
class ExGflashHit {};
class ExGflashHitsCollection {};
class ExGflashMaterialManager {};
class ExGflashPhysicsList {};
class ExGflashPrimaryGeneratorAction {};
class ExGflashRunAction {};
class ExGflashSensitiveDetector {};
/** @} */
/** @} */
@@ -0,0 +1,135 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_persistency.h
/// \brief The page that defines the extended/persistency examples modules
/** @defgroup extended_persistency persistency
* Extended examples persistency classes
* @{
*/
/** @defgroup extended_persistency_gdml gdml
* Extended examples persistency gdml classes
* @{
*/
/** @defgroup extended_persistency_gdml_G01 G01
* Persistency gdml example G01
* @ingroup extended_persistency_gdml
* @{
*/
class G01DetectorConstruction {};
class G01PhysicsList {};
class G01PrimaryGeneratorAction {};
/** @} */
/** @defgroup extended_persistency_gdml_G02 G02
* Persistency gdml example G02
* @ingroup extended_persistency_gdml
* @{
*/
class G02ChamberParameterisation {};
class G02DetectorConstruction {};
class G02DetectorMessenger {};
class G02PrimaryGeneratorAction {};
class G02RunAction {};
/** @} */
/** @defgroup extended_persistency_gdml_G03 G03
* Persistency gdml example G03
* @ingroup extended_persistency_gdml
* @{
*/
class G03ColorReader {};
class G03ColorWriter {};
class G03DetectorConstruction {};
class G03DetectorMessenger {};
class G03PrimaryGeneratorAction {};
class G03RunAction {};
/** @} */
/** @defgroup extended_persistency_gdml_G04 G04
* Persistency gdml example G04
* @ingroup extended_persistency_gdml
* @{
*/
class G04DetectorConstruction {};
class G04PhysicsList {};
class G04PrimaryGeneratorAction {};
class G04SensitiveDetector {};
/** @} */
/** @} */
/** @defgroup extended_persistency_P01 P01
* Persistency example P01
* @ingroup extended_persistency
* @{
*/
class Classes {};
class ExP01ChamberParameterisation {};
class ExP01DetectorConstruction {};
class ExP01DetectorMessenger {};
class ExP01EventAction {};
class ExP01MagneticField {};
class ExP01PhysicsList {};
class ExP01PrimaryGeneratorAction {};
class ExP01RunAction {};
class ExP01SteppingAction {};
class ExP01SteppingVerbose {};
class ExP01TrackerHit {};
class ExP01TrackerSD {};
class RootIO {};
/** @} */
/** @defgroup extended_persistency_P02 P02
* Persistency example P02
* @ingroup extended_persistency
* @{
*/
class ExP02Classes {};
class ExP02DetConstrReader {};
class ExP02DetectorConstruction {};
class ExP02GeoTree {};
class ExP02PhysicsList {};
class ExP02PrimaryGeneratorAction {};
/** @} */
/** @defgroup extended_persistency_P03 P03
* Persistency example P03
* @ingroup extended_persistency
* @{
*/
class ExTGDetectorConstruction {};
class ExTGDetectorConstructionWithCpp {};
class ExTGDetectorConstructionWithCuts {};
class ExTGDetectorConstructionWithSD {};
class ExTGPhysicsList {};
class ExTGPrimaryGeneratorAction {};
class ExTGRCDetectorBuilder {};
class ExTGRCLineProcessor {};
class ExTGRCRegionCutsMgr {};
class ExTGRCRegionData {};
class ExTGRunAction {};
class ExTGTrackerHit {};
class ExTGTrackerSD {};
/** @} */
/** @} */
@@ -0,0 +1,22 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_polarisation.h
/// \brief The page that defines the extended/polarisation examples modules
/** @defgroup extended_polarisation polarisation
* Extended examples eventgenerator classes
* @{
*/
/** @defgroup extended_polarisation_Pol01 Pol01
* polarisation Pol01 example has its
* <a href="../html_Pol01/html/index.html">standalone documentation </a>
* @ingroup extended_polarisation
* @{
*/
/** @} */
/** @} */
@@ -0,0 +1,31 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_radioactivedecay.h
/// \brief The page that defines the extended/radioactivedecay examples modules
/** @defgroup extended_radioactivedecay radioactivedecay
* Extended examples eventgenerator classes
* @{
*/
/** @defgroup extended_radioactivedecay_rdecay01 rdecay01
* radioactivedecay rdecay01 example has its
* <a href="../html_rdecay01/html/index.html">standalone documentation </a>
* @ingroup extended_radioactivedecay
* @{
*/
/** @} */
/** @defgroup extended_radioactivedecay_rdecay02 rdecay02
* radioactivedecay rdecay02 example has its
* <a href="../html_rdecay02/html/index.html">standalone documentation </a>
* @ingroup extended_radioactivedecay
* @{
*/
/** @} */
/** @} */
@@ -0,0 +1,109 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_runAndEvent.h
/// \brief The page that defines the extended/runAndEvent examples modules
/** @defgroup extended_runAndEvent runAndEvent
* Extended runAndEvent examples classes
* @{
*/
/** @defgroup extended_runAndEvent_RE01 RE01
* RunAndEvent example RE01
* @ingroup extended_runAndEvent
* @{
*/
class RE01BosonPhysics {};
class RE01CalorimeterHit {};
class RE01CalorimeterParametrisation {};
class RE01CalorimeterROGeometry {};
class RE01CalorimeterSD {};
class RE01DecayPhysics {};
class RE01DetectorConstruction {};
class RE01DetectorParameterDef {};
class RE01DummySD {};
class RE01EventAction {};
class RE01Field {};
class RE01HadronPhysics {};
class RE01IonPhysics {};
class RE01LeptonPhysics {};
class RE01PhysicsList {};
class RE01PrimaryGeneratorAction {};
class RE01PrimaryGeneratorMessenger {};
class RE01RegionInformation {};
class RE01RunAction {};
class RE01StackingAction {};
class RE01SteppingAction {};
class RE01TrackerHit {};
class RE01TrackerParametrisation {};
class RE01TrackerSD {};
class RE01TrackInformation {};
class RE01TrackingAction {};
class RE01Trajectory {};
/** @} */
/** @defgroup extended_runAndEvent_RE02 RE02
* RunAndEvent example RE02
* @ingroup extended_runAndEvent
* @{
*/
class RE02DetectorConstruction {};
class RE02EMPhysics {};
class RE02EventAction {};
class RE02GeneralPhysics {};
class RE02HadronPhysics {};
class RE02IonPhysics {};
class RE02MuonPhysics {};
class RE02NestedPhantomParameterisation {};
class RE02PhysicsList {};
class RE02PrimaryGeneratorAction {};
class RE02PSCellFlux {};
class RE02PSEnergyDeposit {};
class RE02PSFlatSurfaceCurrent {};
class RE02PSFlatSurfaceFlux {};
class RE02PSNofStep {};
class RE02PSPassageCellFlux {};
class RE02RunAction {};
class RE02Run {};
/** @} */
/** @defgroup extended_runAndEvent_RE03 RE03
* RunAndEvent example RE03
* @ingroup extended_runAndEvent
* @{
*/
class RE03DetectorConstruction {};
class RE03PhysicsList {};
class RE03PrimaryGeneratorAction {};
class RE03UserScoreWriter {};
/** @} */
/** @defgroup extended_runAndEvent_RE04 RE04
* RunAndEvent example RE04
* @ingroup extended_runAndEvent
* @{
*/
class RE04DetectorConstruction {};
class RE04EventAction {};
class RE04ParallelWorldConstruction {};
class RE04ParallelWorldParam {};
class RE04PhysicsList {};
class RE04PrimaryGeneratorAction {};
class RE04SteppingAction {};
class RE04TrackingAction {};
class RE04Trajectory {};
class RE04TrajectoryPoint {};
/** @} */
/** @} */
@@ -0,0 +1,44 @@
// $Id$
// The example class categories definitions for Doxygen
/// \file Doxymodules_visualization.h
/// \brief The page that defines the extended/visualization examples modules
/** @defgroup extended_visualization visualization
* Extended visualization examples classes
* @{
*/
/** @defgroup extended_visualization_perspective perspective
* Visualization example perspective
* @ingroup extended_visualization
* @{
*/
class PerspectiveVisAction {};
class PerspectiveVisActionMessenger {};
/** @} */
/** @defgroup extended_visualization_standalone standalone
* Visualization example standalone
* @ingroup extended_visualization
* @{
*/
class StandaloneVisAction {};
/** @} */
/** @defgroup extended_visualization_userVisAction userVisAction
* visualization example userVisAction
* @ingroup extended_visualization
* @{
*/
class UVA_VisAction {};
/** @} */
/** @} */
@@ -0,0 +1,34 @@
$Id$
-------------------------------------------------------------------
=========================================================
Geant4 - an Object-Oriented Toolkit for Simulation in HEP
=========================================================
Configuration files for Examples Doxygen documentation
----------------------------------------------------------
This file should be used by the G4 example coordinator to briefly
summarize all major modifications introduced in the code and keep
track of all tags.
----------------------------------------------------------
* Reverse chronological order (last date on top), please *
----------------------------------------------------------
26/11/12 I.Hrivnacova (doxygen-V09-05-02)
- Updated Doxyfile for removing .README.HowToRunTestEm1
26/11/12 I.Hrivnacova (doxygen-V09-05-01)
- Completed extended examples
27/06/12 I.Hrivnacova (doxygen-V09-05-00)
- First tag on Doxygen configuration files which now included
extended examples in the generated documentation.
See README file how to process to generate complete examples
(basic & extended) documentation.
@@ -0,0 +1,15 @@
$Id:$
To generate Doxygen documentation for all examples:
1) Check in Doxyfile, Doxyfile_standalone the value of
STRIP_FROM_PATH variable and adjust it if needed
2) Generate documentation for all examples with unique class names
(alltogether):
doxygen >& doxygen.out
3) Generate documentation for examples with non-unique class names
(a standalone documentation will be generated for each example)
./generate_standalone.sh
@@ -0,0 +1,56 @@
#!/bin/sh
# Script to generate standalone Doxygen documentation
# for the examples with non unique class names.
CURDIR=`pwd`
BACK_PATH2="../../../.doxygen/doc"
BACK_PATH4="../../../../../.doxygen/doc"
# generate documentation
# {1} example directory
# {2} relative path from the example to the doc directory
generate() {
echo "processing ${1}"
cd ../extended/${1}
EXAMPLE_NAME=${PWD##*/}
# add directory if shared
if [ "${EXAMPLE_NAME}" = "shared" ]; then
cd ..
DIR_NAME=${PWD##*/}
EXAMPLE_NAME=${DIR_NAME}"_shared"
cd shared
fi
# detect use of classes from shared
ADD_SHARED=""
if [ -f SharedFilesList.txt ]; then
if [ "`grep SHARED_CLASSES_LIST SharedFilesList.txt`" = "SHARED_CLASSES_LIST" ]; then
ADD_SHARED="../shared"
fi
fi
# detect use of classes from common
ADD_COMMON=""
if [ -f SharedFilesList.txt ]; then
if [ "`grep COMMON_CLASSES_LIST SharedFilesList.txt`" = "COMMON_CLASSES_LIST" ]; then
ADD_COMMON="../../common ../../../common"
fi
fi
#echo "Generating Doxyfile for example: ${EXAMPLE_NAME}"
cat $CURDIR/Doxyfile_standalone | sed s/"EXAMPLE_NAME"/"${EXAMPLE_NAME}"/g | sed sY"BACK_PATH"Y"${2}"Yg | sed sY"ADD_SHARED"Y"${ADD_SHARED}"Yg | sed sY"ADD_COMMON"Y"${ADD_COMMON}"Yg > Doxyfile
doxygen >& $CURDIR/doxygen_${EXAMPLE_NAME}.out
rm Doxyfile
cd $CURDIR
}
# process examples in second level directory in extended
for DIR in analysis/shared analysis/AnaEx01 analysis/AnaEx02 analysis/AnaEx03 electromagnetic/TestEm0 electromagnetic/TestEm1 electromagnetic/TestEm2 electromagnetic/TestEm3 electromagnetic/TestEm4 electromagnetic/TestEm5 electromagnetic/TestEm6 electromagnetic/TestEm7 electromagnetic/TestEm8 electromagnetic/TestEm9 electromagnetic/TestEm10 electromagnetic/TestEm11 electromagnetic/TestEm12 electromagnetic/TestEm13 electromagnetic/TestEm14 electromagnetic/TestEm15 electromagnetic/TestEm16 electromagnetic/TestEm17 electromagnetic/TestEm18 eventgenerator/particleGun exoticphysics/monopole geometry/transforms hadronic/Hadr00 hadronic/Hadr01 hadronic/Hadr02 hadronic/Hadr03 medical/electronScattering medical/electronScattering2 medical/fanoCavity medical/fanoCavity2 medical/GammaTherapy parallel/ParN02 parallel/ParN04 polarisation/Pol01 radioactivedecay/rdecay01 radioactivedecay/rdecay02; do
generate ${DIR} ${BACK_PATH2}
done
# process examples in fourth level directory in extended
for DIR in parallel/MPI/examples/exMPI01 parallel/MPI/examples/exMPI02; do
generate ${DIR} ${BACK_PATH4}
done
cd $CURDIR
+352 -126
View File
@@ -1,4 +1,4 @@
# Doxyfile 1.7.3
# Doxyfile 1.8.2
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
@@ -22,8 +22,9 @@
DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
# The PROJECT_NAME tag is a single word (or sequence of words) that should
# identify the project. Note that if you do not use Doxywizard you need
# to put quotes around the project name if it contains spaces.
PROJECT_NAME = "Geant4 examples"
@@ -33,7 +34,9 @@ PROJECT_NAME = "Geant4 examples"
PROJECT_NUMBER =
# Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. Keep the description short.
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer
# a quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF =
@@ -49,7 +52,7 @@ PROJECT_LOGO =
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY =
OUTPUT_DIRECTORY = doc
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -123,9 +126,11 @@ FULL_PATH_NAMES = YES
# only done if one of the specified strings matches the left-hand part of
# the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the
# path to strip.
# path to strip. Note that you specify absolute paths here, but also
# relative paths, which will be relative from the directory where doxygen is
# started.
STRIP_FROM_PATH = /home/work/packages/geant4/geant4_ref/examples/
STRIP_FROM_PATH = /home/work/packages/geant4/geant4_ref-gnumakefile/examples/
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
@@ -192,6 +197,13 @@ TAB_SIZE = 8
ALIASES =
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding
# "class=itcl::class" will allow you to use the command class in the
# itcl::class meaning.
TCL_SUBST =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.
# For instance, some of the names that are used will be different. The list
@@ -219,17 +231,34 @@ OPTIMIZE_FOR_FORTRAN = NO
OPTIMIZE_OUTPUT_VHDL = NO
# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given extension.
# Doxygen has a built-in mapping, but you can override or extend it using this
# tag. The format is ext=language, where ext is a file extension, and language
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension,
# and language is one of the parsers supported by doxygen: IDL, Java,
# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
# C++. For instance to make doxygen treat .inc files as Fortran files (default
# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
# that for custom extensions you also need to set FILE_PATTERNS otherwise the
# files are not read by doxygen.
EXTENSION_MAPPING =
# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
# comments according to the Markdown format, which allows for more readable
# documentation. See http://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you
# can mix doxygen, HTML, and XML commands with Markdown formatting.
# Disable only in case of backward compatibilities issues.
MARKDOWN_SUPPORT = YES
# When enabled doxygen tries to link words that correspond to documented classes,
# or namespaces to their corresponding documentation. Such a link can be
# prevented in individual cases by by putting a % sign in front of the word or
# globally by setting AUTOLINK_SUPPORT to NO.
AUTOLINK_SUPPORT = YES
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should
# set this tag to YES in order to let doxygen match functions declarations and
@@ -250,12 +279,7 @@ CPP_CLI_SUPPORT = NO
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate getter
# and setter methods for a property. Setting this option to YES (the default)
# will make doxygen replace the get and set methods by a property in the
# documentation. This will only work if the methods are indeed getting or
# setting a simple type. If this is not the case, or you want to show the
# methods anyway, you should set this option to NO.
# For Microsoft's IDL there are propget and propput attributes to indicate getter and setter methods for a property. Setting this option to YES (the default) will make doxygen replace the get and set methods by a property in the documentation. This will only work if the methods are indeed getting or setting a simple type. If this is not the case, or you want to show the methods anyway, you should set this option to NO.
IDL_PROPERTY_SUPPORT = YES
@@ -274,6 +298,22 @@ DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = YES
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
# unions are shown inside the group in which they are included (e.g. using
# @ingroup) instead of on a separate page (for HTML and Man pages) or
# section (for LaTeX and RTF).
INLINE_GROUPED_CLASSES = NO
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
# unions with only public data fields will be shown inline in the documentation
# of the scope in which they are defined (i.e. file, namespace, or group
# documentation), provided this scope is documented. If set to NO (the default),
# structs, classes, and unions are shown on a separate page (for HTML and Man
# pages) or section (for LaTeX and RTF).
INLINE_SIMPLE_STRUCTS = NO
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
# is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
@@ -296,10 +336,21 @@ TYPEDEF_HIDES_STRUCT = NO
# a logarithmic scale so increasing the size by one will roughly double the
# memory usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols
# corresponding to a cache size of 2^16 = 65536 symbols.
SYMBOL_CACHE_SIZE = 0
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
# their name and scope. Since this can be an expensive process and often the
# same symbol appear multiple times in the code, doxygen keeps a cache of
# pre-resolved symbols. If the cache is too small doxygen will become slower.
# If the cache is too large, memory is wasted. The cache size is given by this
# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols.
LOOKUP_CACHE_SIZE = 0
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
@@ -316,6 +367,11 @@ EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
# scope will be included in the documentation.
EXTRACT_PACKAGE = NO
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
@@ -449,8 +505,11 @@ SORT_GROUP_NAMES = NO
SORT_BY_SCOPE_NAME = NO
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper type resolution of all parameters of a function it will reject a
# match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
# do proper type resolution of all parameters of a function it will reject a
# match between the prototype and the implementation of a member function even
# if there is only one candidate or it is obvious which candidate to choose
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
# will still accept a match between prototype and implementation in such cases.
STRICT_PROTO_MATCHING = NO
@@ -500,12 +559,6 @@ MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO.
SHOW_DIRECTORIES = NO
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
# Folder Tree View (if specified). The default is YES.
@@ -531,13 +584,23 @@ FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. The create the layout file
# output files in an output format independent way. To create the layout file
# that represents doxygen's defaults, run doxygen with the -l option.
# You can optionally specify a file name after the option, if omitted
# DoxygenLayout.xml will be used as the name of the layout file.
LAYOUT_FILE =
# The CITE_BIB_FILES tag can be used to specify one or more bib files
# containing the references data. This must be a list of .bib files. The
# .bib extension is automatically appended if omitted. Using this command
# requires the bibtex tool to be installed. See also
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
# feature you need bibtex and perl available in the search path.
CITE_BIB_FILES =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
@@ -598,19 +661,97 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
# trunk
#INPUT = Doxymain.h Doxymodules_basic.h \
# Doxymodules_common.h Doxymodules_new.h \
# ../basic/.README ../extended/.README \
# ../basic/B1 ../basic/B2 ../basic/B3 ../basic/B4 \
# ../extended/common ../extended/new
# release
INPUT = Doxymain.h Doxymodules_basic.h \
Doxymodules_common.h \
../basic/.README ../extended/.README \
Doxymodules_common.h Doxymodules_analysis.h \
Doxymodules_biasing.h Doxymodules_electromagnetic.h \
Doxymodules_errorpropagation.h \
Doxymodules_eventgenerator.h Doxymodules_exoticphysics.h \
Doxymodules_field.h Doxymodules_g3tog4.h \
Doxymodules_geometry.h Doxymodules_hadronic.h \
Doxymodules_medical.h \
Doxymodules_optical.h Doxymodules_parallel.h \
Doxymodules_parameterisations.h Doxymodules_persistency.h \
Doxymodules_polarisation.h Doxymodules_radioactivedecay.h \
Doxymodules_runAndEvent.h Doxymodules_visualization.h \
.README.HowToNavigate \
../.README.HowToRun \
../basic/.README \
../basic/B1 ../basic/B2 ../basic/B3 ../basic/B4 \
../extended/common
../extended/.README \
../extended/common \
../extended/analysis/.README \
../extended/analysis/A01 \
../extended/analysis/AnaEx01/.README \
../extended/analysis/AnaEx02/.README \
../extended/analysis/AnaEx03/.README \
../extended/analysis/N03Con/.README \
../extended/biasing \
../extended/electromagnetic/.README \
../extended/electromagnetic/TestEm0/.README \
../extended/electromagnetic/TestEm1/.README \
../extended/electromagnetic/TestEm2/.README \
../extended/electromagnetic/TestEm3/.README \
../extended/electromagnetic/TestEm4/.README \
../extended/electromagnetic/TestEm5/.README \
../extended/electromagnetic/TestEm6/.README \
../extended/electromagnetic/TestEm7/.README \
../extended/electromagnetic/TestEm8/.README \
../extended/electromagnetic/TestEm9/.README \
../extended/electromagnetic/TestEm10/.README \
../extended/electromagnetic/TestEm11/.README \
../extended/electromagnetic/TestEm12/.README \
../extended/electromagnetic/TestEm13/.README \
../extended/electromagnetic/TestEm14/.README \
../extended/electromagnetic/TestEm15/.README \
../extended/electromagnetic/TestEm16/.README \
../extended/electromagnetic/TestEm17/.README \
../extended/electromagnetic/TestEm18/.README \
../extended/errorpropagation \
../extended/eventgenerator/.README \
../extended/eventgenerator/exgps \
../extended/eventgenerator/HepMC/.README \
../extended/eventgenerator/HepMC/HepMCEx01 \
../extended/eventgenerator/HepMC/HepMCEx02 \
../extended/eventgenerator/HepMC/MCTruth \
../extended/eventgenerator/particleGun/.README \
../extended/eventgenerator/pythia/.README \
../extended/eventgenerator/pythia/decayer6 \
../extended/exoticphysics/.README \
../extended/exoticphysics/monopole/.README \
../extended/exoticphysics/phonon \
../extended/field \
../extended/g3tog4 \
../extended/geometry/.README \
../extended/geometry/transforms/.README \
../extended/geometry/olap \
../extended/hadronic/.README \
../extended/hadronic/Hadr00/.README \
../extended/hadronic/Hadr01/.README \
../extended/hadronic/Hadr02/.README \
../extended/hadronic/Hadr03/.README \
../extended/medical/.README \
../extended/medical/DICOM \
../extended/medical/electronScattering/.README \
../extended/medical/electronScattering2/.README \
../extended/medical/fanoCavity/.README \
../extended/medical/fanoCavity2/.README \
../extended/medical/GammaTherapy/.README \
../extended/optical \
../extended/parallel/.README \
../extended/parallel/MPI/.README \
../extended/parallel/MPI/examples/exMPI01/.README \
../extended/parallel/MPI/examples/exMPI02/.README \
../extended/parallel/ParN02/.README \
../extended/parallel/ParN04/.README \
../extended/parameterisations \
../extended/persistency \
../extended/polarisation/.README \
../extended/polarisation/Pol01/.README \
../extended/radioactivedecay/.README \
../extended/radioactivedecay/rdecay01/.README \
../extended/radioactivedecay/rdecay02/.README \
../extended/runAndEvent \
../extended/visualization
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -628,7 +769,7 @@ INPUT_ENCODING = UTF-8
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
# *.f90 *.f *.for *.vhd *.vhdl
FILE_PATTERNS = *.hh *.icc *.cc .README
FILE_PATTERNS = *.hh *.icc *.cc .README* *.mac
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
@@ -636,9 +777,11 @@ FILE_PATTERNS = *.hh *.icc *.cc .README
RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should
# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
# Note that relative paths are relative to the directory from which doxygen is
# run.
EXCLUDE = ../basic/B2/B2b/include/B2EventAction.hh \
../basic/B2/B2b/include/B2MagneticField.hh \
@@ -670,9 +813,36 @@ EXCLUDE = ../basic/B2/B2b/include/B2EventAction.hh \
../basic/B4/B4d/include/B4RunAction.hh \
../basic/B4/B4b/src/B4RunAction.cc \
../basic/B4/B4c/src/B4RunAction.cc \
../basic/B4/B4d/src/B4RunAction.cc
../basic/B4/B4d/src/B4RunAction.cc \
../extended/eventgenerator/HepMC/HepMCEx02/include/HepMCG4AsciiReader.hh \
../extended/eventgenerator/HepMC/HepMCEx02/include/HepMCG4AsciiReaderMessenger.hh \
../extended/eventgenerator/HepMC/HepMCEx02/include/HepMCG4Interface.hh \
../extended/eventgenerator/HepMC/HepMCEx02/include/HepMCG4PythiaInterface.hh \
../extended/eventgenerator/HepMC/HepMCEx02/include/HepMCG4PythiaMessenger.hh \
../extended/eventgenerator/HepMC/HepMCEx02/src/HepMCG4AsciiReader.cc \
../extended/eventgenerator/HepMC/HepMCEx02/src/HepMCG4AsciiReaderMessenger.cc \
../extended/eventgenerator/HepMC/HepMCEx02/src/HepMCG4Interface.cc \
../extended/eventgenerator/HepMC/HepMCEx02/src/HepMCG4PythiaInterface.cc \
../extended/eventgenerator/HepMC/HepMCEx02/src/HepMCG4PythiaMessenger.cc \
../extended/eventgenerator/HepMC/MCTruth/include/DetectorConstruction.hh \
../extended/eventgenerator/HepMC/MCTruth/include/PhysicsList.hh \
../extended/eventgenerator/HepMC/MCTruth/include/PrimaryGeneratorAction.hh \
../extended/eventgenerator/HepMC/MCTruth/src/DetectorConstruction.cc \
../extended/eventgenerator/HepMC/MCTruth/src/PhysicsList.cc \
../extended/eventgenerator/HepMC/MCTruth/src/PrimaryGeneratorAction.cc \
../extended/visualization/userVisAction/include/B1DetectorConstruction.hh \
../extended/visualization/userVisAction/include/B1EventAction.hh \
../extended/visualization/userVisAction/include/B1PrimaryGeneratorAction.hh \
../extended/visualization/userVisAction/include/B1RunAction.hh \
../extended/visualization/userVisAction/include/B1SteppingAction.hh \
../extended/visualization/userVisAction/src/B1DetectorConstruction.cc \
../extended/visualization/userVisAction/src/B1EventAction.cc \
../extended/visualization/userVisAction/src/B1PrimaryGeneratorAction.cc \
../extended/visualization/userVisAction/src/B1RunAction.cc \
../extended/visualization/userVisAction/src/B1SteppingAction.cc
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.
@@ -684,7 +854,7 @@ EXCLUDE_SYMLINKS = NO
# against the file with absolute path, so to exclude all test directories
# for example use the pattern */test/*
EXCLUDE_PATTERNS =
EXCLUDE_PATTERNS = */.svn/*
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
@@ -718,7 +888,7 @@ EXAMPLE_RECURSIVE = NO
# directories that contain image that are included in the documentation (see
# the \image command).
IMAGE_PATH = .
IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
@@ -729,7 +899,7 @@ IMAGE_PATH = .
# If FILTER_PATTERNS is specified, this tag will be
# ignored.
INPUT_FILTER =
INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis.
@@ -774,9 +944,9 @@ INLINE_SOURCES = YES
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
# fragments. Normal C and C++ comments will always remain visible.
# fragments. Normal C, C++ and Fortran comments will always remain visible.
STRIP_CODE_COMMENTS = YES
STRIP_CODE_COMMENTS = NO
# If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented
@@ -858,7 +1028,14 @@ HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a personal HTML header for
# each generated HTML page. If it is left blank doxygen will generate a
# standard header.
# standard header. Note that when using a custom header you are responsible
# for the proper inclusion of any scripts and style sheets that doxygen
# needs, which is dependent on the configuration options used.
# It is advised to generate a default header using "doxygen -w html
# header.html footer.html stylesheet.css YourConfigFile" and then modify
# that header. Note that the header is subject to change so you typically
# have to redo this when upgrading to a newer version of doxygen or when
# changing the value of configuration settings such as GENERATE_TREEVIEW!
HTML_HEADER =
@@ -868,22 +1045,36 @@ HTML_HEADER =
HTML_FOOTER =
# If the HTML_TIMESTAMP tag is set to YES then the generated HTML
# documentation will contain the timesstamp.
HTML_TIMESTAMP = NO
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen
# will generate a default style sheet. Note that doxygen will try to copy
# the style sheet file to the HTML output directory, so don't put your own
# stylesheet in the HTML output directory as well, or it will be erased!
# fine-tune the look of the HTML output. If left blank doxygen will
# generate a default style sheet. Note that it is recommended to use
# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
# tag will in the future become obsolete.
HTML_STYLESHEET =
# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
# user-defined cascading style sheet that is included after the standard
# style sheets created by doxygen. Using this option one can overrule
# certain style aspects. This is preferred over using HTML_STYLESHEET
# since it does not replace the standard style sheet and is therefor more
# robust against future updates. Doxygen will copy the style sheet file to
# the output directory.
HTML_EXTRA_STYLESHEET =
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
# files. In the HTML_STYLESHEET file, use the file name only. Also note that
# the files will be copied as-is; there are no commands or markers available.
HTML_EXTRA_FILES =
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
# Doxygen will adjust the colors in the stylesheet and background images
# Doxygen will adjust the colors in the style sheet and background images
# according to this color. Hue is specified as an angle on a colorwheel,
# see http://en.wikipedia.org/wiki/Hue for more information.
# For instance the value 0 represents red, 60 is yellow, 120 is green,
@@ -913,20 +1104,23 @@ HTML_COLORSTYLE_GAMMA = 80
HTML_TIMESTAMP = YES
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used.
HTML_ALIGN_MEMBERS = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded. For this to work a browser that supports
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
# page has loaded.
HTML_DYNAMIC_SECTIONS = NO
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
# entries shown in the various tree structured indices initially; the user
# can expand and collapse entries dynamically later on. Doxygen will expand
# the tree to such a level that at most the specified number of entries are
# visible (unless a fully collapsed tree already exceeds this amount).
# So setting the number of entries 1 will produce a full collapsed tree by
# default. 0 is a special value representing an infinite number of entries
# and will result in a full expanded tree by default.
HTML_INDEX_NUM_ENTRIES = 100
# If the GENERATE_DOCSET tag is set to YES, additional index files
# will be generated that can be used as input for Apple's Xcode 3
# integrated development environment, introduced with OSX 10.5 (Leopard).
@@ -954,9 +1148,9 @@ DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_BUNDLE_ID = org.doxygen.Project
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
# identify the documentation publisher. This should be a reverse domain-name
# style string, e.g. com.mycompany.MyDocSet.documentation.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
@@ -1078,18 +1272,14 @@ GENERATE_ECLIPSEHELP = NO
ECLIPSE_DOC_ID = org.doxygen.Project
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and
# the value YES disables it.
# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
# at top of each HTML page. The value NO (the default) enables the index and
# the value YES disables it. Since the tabs have the same information as the
# navigation tree you can set this option to NO if you already set
# GENERATE_TREEVIEW to YES.
DISABLE_INDEX = NO
# This tag can be used to set the number of enum values (range [0,1..20])
# that doxygen will group on one line in the generated HTML documentation.
# Note that a value of 0 will completely suppress the enum values from appearing in the overview section.
ENUM_VALUES_PER_LINE = 4
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information.
# If the tag value is set to YES, a side panel will be generated
@@ -1097,13 +1287,17 @@ ENUM_VALUES_PER_LINE = 4
# is generated for HTML Help). For this to work a browser that supports
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
# Windows users are probably better off using the HTML help feature.
# Since the tree basically has the same information as the tab index you
# could consider to set DISABLE_INDEX to NO when enabling this option.
GENERATE_TREEVIEW = NO
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list.
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
# documentation. Note that a value of 0 will completely suppress the enum
# values from appearing in the overview section.
USE_INLINE_TREES = NO
ENUM_VALUES_PER_LINE = 4
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
@@ -1136,7 +1330,7 @@ FORMULA_TRANSPARENT = YES
# (see http://www.mathjax.org) which uses client side Javascript for the
# rendering instead of using prerendered bitmaps. Use this if you do not
# have LaTeX installed or if you want to formulas look prettier in the HTML
# output. When enabled you also need to install MathJax separately and
# output. When enabled you may also need to install MathJax separately and
# configure the path to it using the MATHJAX_RELPATH option.
USE_MATHJAX = NO
@@ -1145,11 +1339,18 @@ USE_MATHJAX = NO
# HTML output directory using the MATHJAX_RELPATH option. The destination
# directory should contain the MathJax.js script. For instance, if the mathjax
# directory is located at the same level as the HTML output directory, then
# MATHJAX_RELPATH should be ../mathjax. The default value points to the mathjax.org site, so you can quickly see the result without installing
# MathJax, but it is strongly recommended to install a local copy of MathJax
# before deployment.
# MATHJAX_RELPATH should be ../mathjax. The default value points to
# the MathJax Content Delivery Network so you can quickly see the result without
# installing MathJax.
# However, it is strongly recommended to install a local
# copy of MathJax from http://www.mathjax.org before deployment.
MATHJAX_RELPATH = http://www.mathjax.org/mathjax
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
# names that should be enabled during MathJax rendering.
MATHJAX_EXTENSIONS =
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
# for the HTML output. The underlying search engine uses javascript
@@ -1178,7 +1379,7 @@ SERVER_BASED_SEARCH = NO
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
GENERATE_LATEX = NO
GENERATE_LATEX = YES
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
@@ -1224,6 +1425,13 @@ EXTRA_PACKAGES =
LATEX_HEADER =
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
# the generated latex document. The footer should contain everything after
# the last chapter. If it is left blank doxygen will generate a
# standard footer. Notice: only use this tag if you know what you are doing!
LATEX_FOOTER =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
# contain links (just like the HTML output) instead of page references
@@ -1257,6 +1465,12 @@ LATEX_HIDE_INDICES = NO
LATEX_SOURCE_CODE = NO
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
# http://en.wikipedia.org/wiki/BibTeX for more info.
LATEX_BIB_STYLE = plain
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
@@ -1288,7 +1502,7 @@ COMPACT_RTF = NO
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# Load style sheet definitions from file. Syntax is similar to doxygen's
# config file, i.e. a series of assignments. You only have to provide
# replacements, missing definitions are set to their default value.
@@ -1433,7 +1647,7 @@ MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
# in the INCLUDE_PATH (see below) will be search if a #include is found.
# pointed to by INCLUDE_PATH will be searched when a #include is found.
SEARCH_INCLUDES = YES
@@ -1463,7 +1677,8 @@ PREDEFINED = G4_USE_HBOOK
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
# The macro definition that is found in the sources will be used.
# Use the PREDEFINED tag if you want to use a different macro definition that overrules the definition found in the source code.
# Use the PREDEFINED tag if you want to use a different macro definition that
# overrules the definition found in the source code.
EXPAND_AS_DEFINED =
@@ -1478,28 +1693,21 @@ SKIP_FUNCTION_MACROS = YES
# Configuration::additions related to external references
#---------------------------------------------------------------------------
# The TAGFILES option can be used to specify one or more tagfiles.
# Optionally an initial location of the external documentation
# can be added for each tagfile. The format of a tag file without
# this location is as follows:
# The TAGFILES option can be used to specify one or more tagfiles. For each
# tag file the location of the external documentation should be added. The
# format of a tag file without this location is as follows:
#
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
#
# TAGFILES = file1=loc1 "file2 = loc2" ...
# where "loc1" and "loc2" can be relative or absolute paths or
# URLs. If a location is present for each tag, the installdox tool
# does not have to be run to correct the links.
# Note that each tag file must have a unique name
# (where the name does NOT include the path)
# If a tag file is not located in the directory in which doxygen
# is run, you must also specify the path to the tagfile here.
# where "loc1" and "loc2" can be relative or absolute paths
# or URLs. Note that each tag file must have a unique name (where the name does
# NOT include the path). If a tag file is not located in the directory in which
# doxygen is run, you must also specify the path to the tagfile here.
# The geant4.tag file has to be downloaded from:
# http://www-geant4.kek.jp/Reference/"version number"/geant4.tag
# before generation of documentation
#
TAGFILES = geant4.tag=http://www-geant4.kek.jp/Reference/9.4.p02
TAGFILES = geant4.tag=http://www-geant4.kek.jp/Reference/9.5.p01
#TAGFILES = geant4.tag
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
@@ -1565,13 +1773,12 @@ HAVE_DOT = NO
DOT_NUM_THREADS = 0
# By default doxygen will write a font called Helvetica to the output
# directory and reference it in all dot files that doxygen generates.
# When you want a differently looking font you can specify the font name
# using DOT_FONTNAME. You need to make sure dot is able to find the font,
# which can be done by putting it in a standard location or by setting the
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
# containing the font.
# By default doxygen will use the Helvetica font for all dot files that
# doxygen generates. When you want a differently looking font you can specify
# the font name using DOT_FONTNAME. You need to make sure dot is able to find
# the font, which can be done by putting it in a standard location or by setting
# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
# directory containing the font.
DOT_FONTNAME = Helvetica
@@ -1580,17 +1787,16 @@ DOT_FONTNAME = Helvetica
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the output directory to look for the
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
# different font using DOT_FONTNAME you can set the path where dot
# can find it using this tag.
# By default doxygen will tell dot to use the Helvetica font.
# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
# set the path where dot can find it.
DOT_FONTPATH =
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect inheritance relations. Setting this tag to YES will force the
# the CLASS_DIAGRAMS tag to NO.
# CLASS_DIAGRAMS tag to NO.
CLASS_GRAPH = YES
@@ -1612,6 +1818,15 @@ GROUP_GRAPHS = YES
UML_LOOK = NO
# If the UML_LOOK tag is enabled, the fields and methods are shown inside
# the class node. If there are many fields or methods and many nodes the
# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
# threshold limits the number of items for each type to make the size more
# managable. Set this to 0 for no limit. Note that the threshold may be
# exceeded by 50% before the limit is enforced.
UML_LIMIT_NUM_FIELDS = 10
# If set to YES, the inheritance and collaboration graphs will show the
# relations between templates and their instances.
@@ -1652,7 +1867,7 @@ CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
# then doxygen will show the dependencies a directory has on other directories
# in a graphical way. The dependency relations are determined by the #include
# relations between the files in the directories.
@@ -1660,11 +1875,22 @@ GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. Possible values are png, svg, gif or svg.
# If left blank png will be used.
# generated by dot. Possible values are svg, png, jpg, or gif.
# If left blank png will be used. If you choose svg you need to set
# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
# visible in IE 9+ (other browsers do not have this requirement).
DOT_IMAGE_FORMAT = png
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
# Note that this requires a modern browser other than Internet Explorer.
# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
# visible. Older versions of IE do not have SVG support.
INTERACTIVE_SVG = NO
# The tag DOT_PATH can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
File diff suppressed because it is too large Load Diff
+9 -2
View File
@@ -1,4 +1,4 @@
// $Id: Doxymain.h 55087 2011-11-16 10:11:00Z gcosmo $
// $Id: Doxymain.h 65679 2012-11-26 13:41:53Z gcosmo $
/// \file Doxymain.h
/// \brief The main page for Geant4 Examples code documenation
@@ -35,7 +35,14 @@ See more on each examples category pages:
- \ref README_basic
- \ref README_extended
- <a href="http://geant4advancedexampleswg.wikispaces.com/ExamplesDocumentation">
Geant4 Advanced Examples </a>
Advanced Examples </a>
And more on what is common for all examples:
- \ref README_HowToRun
- \ref README_HowToNavigate
*/
+91
View File
@@ -0,0 +1,91 @@
// $Id: Doxymodules_analysis.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_analysis.h
/// \brief The page that defines the extended/analysis examples modules
/** @defgroup extended_analysis analysis
* Extended examples analysis classes
* @{
*/
/** @defgroup extended_analysis_A01 A01
* Analysis example A01
* @ingroup extended_analysis
* @{
*/
class A01AnalysisManager {};
class A01CellParameterisation {};
class A01DetectorConstMessenger {};
class A01DetectorConstruction {};
class A01DriftChamber {};
class A01DriftChamberHit {};
class A01EmCalorimeter {};
class A01EmCalorimeterHit {};
class A01EMPhysics {};
class A01EventAction {};
class A01EventActionMessenger {};
class A01GeneralPhysics {};
class A01HadCalorimeter {};
class A01HadCalorimeterHit {};
class A01HadronPhysics {};
class A01Hodoscope {};
class A01HodoscopeHit {};
class A01IonPhysics {};
class A01MagneticField {};
class A01MagneticFieldMessenger {};
class A01MuonPhysics {};
class A01PhysicsList {};
class A01PrimaryGeneratorAction {};
class A01PrimaryGeneratorMessenger {};
/** @} */
/** @defgroup extended_analysis_shared shared
* The shared analysis classes have their
* <a href="../html_analysis_shared/html/index.html">standalone documentation </a>
* @ingroup extended_analysis
* @{
*/
/** @} */
/** @defgroup extended_analysis_AnaEx01 AnaEx01
* Analysis AnaEx01 example has its
* <a href="../html_AnaEx01/html/index.html">standalone documentation </a>
* @ingroup extended_analysis
* @{
*/
/** @} */
/** @defgroup extended_analysis_AnaEx02 AnaEx02
* Analysis AnaEx02 example has its
* <a href="../html_AnaEx02/html/index.html">standalone documentation </a>
* @ingroup extended_analysis
* @{
*/
/** @} */
/** @defgroup extended_analysis_AnaEx03 AnaEx03
* Analysis AnaEx03 example has its
* <a href="../html_AnaEx03/html/index.html">standalone documentation </a>
* @ingroup extended_analysis
* @{
*/
/** @} */
/** @defgroup extended_analysis_N03Con N03Con
* Analysis AnaEx03 example has its
* <a href="../html_N03Con/html/index.html">standalone documentation </a>
* @ingroup extended_analysis
* @{
*/
/** @} */
/** @} */
+2 -10
View File
@@ -1,8 +1,8 @@
// $Id: Doxymodules_basic.h 55087 2011-11-16 10:11:00Z gcosmo $
// $Id: Doxymodules_basic.h 65679 2012-11-26 13:41:53Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_basic.h
/// \brief The page that defines the class groups for examples documentation
/// \brief The page that defines the basic examples modules
/** @defgroup basic basic
@@ -97,10 +97,8 @@
*/
class B4aEventAction{};
class B4aEventActionMessenger{};
class B4aSteppingAction{};
class B4DetectorConstruction{};
class B4DetectorMessenger{};
class B4PrimaryGeneratorAction{};
class B4RunAction{};
@@ -114,11 +112,9 @@
*/
class B4bEventAction{};
class B4bEventActionMessenger{};
class B4bRunData{};
class B4bSteppingAction{};
class B4DetectorConstruction{};
class B4DetectorMessenger{};
class B4PrimaryGeneratorAction{};
class B4RunAction{};
@@ -131,11 +127,9 @@
*/
class B4cDetectorConstruction{};
class B4cDetectorMessenger{};
class B4cCalorHit{};
class B4cCalorimeterSD{};
class B4cEventAction{};
class B4cEventActionMessenger{};
class B4PrimaryGeneratorAction{};
class B4RunAction{};
@@ -149,9 +143,7 @@
*/
class B4dDetectorConstruction{};
class B4dDetectorMessenger{};
class B4dEventAction{};
class B4dEventActionMessenger{};
class B4PrimaryGeneratorAction{};
class B4RunAction{};
+76
View File
@@ -0,0 +1,76 @@
// $Id: Doxymodules_biasing.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_biasing.h
/// \brief The page that defines the extended/biasing examples modules
/** @defgroup extended_biasing biasing
* Extended examples biasing classes
* @{
*/
/** @defgroup extended_biasing_B01 B01
* Biasing example B01
* @ingroup extended_biasing
* @{
*/
class B01DetectorConstruction {};
class B01PhysicsList {};
class B01PrimaryGeneratorAction {};
class B01RunAction {};
class B01Run {};
class B01ScoreTable {};
/** @} */
/** @defgroup extended_biasing_B02 B02
* Biasing example B02
* @ingroup extended_biasing
* @{
*/
class B02CellScorer {};
class B02CellScorerStore {};
class B02DetectorConstruction {};
class B02ImportanceDetectorConstruction {};
class B02PhysicsList {};
class B02PrimaryGeneratorAction {};
class B02PSScoringDetectorConstruction {};
class B02PVolumeStore {};
class B02RunAction {};
class B02Run {};
class B02ScoreTable {};
class B02ScoringDetectorConstruction {};
/** @} */
/** @defgroup extended_biasing_ReverseMC01 ReverseMC01
* Biasing example ReverseMC01
* @ingroup extended_biasing
* @{
*/
class G4AdjointPhysicsList {};
class G4AdjointPhysicsMessenger {};
class Histo1DVar {};
class Histo2DVar {};
class Histograms {};
class RMC01AdjointEventAction {};
class RMC01AnalysisManager {};
class RMC01AnalysisManagerMessenger {};
class RMC01DetectorConstruction {};
class RMC01DetectorMessenger {};
class RMC01DoubleWithWeightHit {};
class RMC01EventAction {};
class RMC01PrimaryGeneratorAction {};
class RMC01RunAction {};
class RMC01SD {};
enum side {};
class VariableLengthPartition {};
/** @} */
/** @} */
+2 -2
View File
@@ -1,8 +1,8 @@
// $Id: Doxymodules_common.h 55417 2011-11-23 11:19:12Z gcosmo $
// $Id: Doxymodules_common.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_common.h
/// \brief The page that defines the class groups for examples documentation
/// \brief The page that defines the extended/common classes modules
/** @defgroup extended_common common
@@ -0,0 +1,185 @@
// $Id: Doxymodules_electromagnetic.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_electromagnetic.h
/// \brief The page that defines the extended/electromagnetic examples modules
/** @defgroup extended_electromagnetic electromagnetic
* Extended examples electromagnetic classes
* @{
*/
/** @defgroup extended_electromagnetic_TestEm0 TestEm0
* The TestEm0 electromagnetic classes have their
* <a href="../html_TestEm0/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm1 TestEm1
* The TestEm1 electromagnetic classes have their
* <a href="../html_TestEm1/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm2 TestEm2
* The TestEm2 electromagnetic classes have their
* <a href="../html_TestEm2/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm3 TestEm3
* The TestEm3 electromagnetic classes have their
* <a href="../html_TestEm3/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm4 TestEm4
* The TestEm4 electromagnetic classes have their
* <a href="../html_TestEm4/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm5 TestEm5
* The TestEm5 electromagnetic classes have their
* <a href="../html_TestEm5/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm6 TestEm6
* The TestEm6 electromagnetic classes have their
* <a href="../html_TestEm6/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm7 TestEm7
* The TestEm7 electromagnetic classes have their
* <a href="../html_TestEm7/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm8 TestEm8
* The TestEm8 electromagnetic classes have their
* <a href="../html_TestEm8/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm9 TestEm9
* The TestEm9 electromagnetic classes have their
* <a href="../html_TestEm9/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm10 TestEm10
* The TestEm10 electromagnetic classes have their
* <a href="../html_TestEm10/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm11 TestEm11
* The TestEm11 electromagnetic classes have their
* <a href="../html_TestEm11/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm12 TestEm12
* The TestEm12 electromagnetic classes have their
* <a href="../html_TestEm12/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm13 TestEm13
* The TestEm13 electromagnetic classes have their
* <a href="../html_TestEm13/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm14 TestEm14
* The TestEm14 electromagnetic classes have their
* <a href="../html_TestEm14/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm15 TestEm15
* The TestEm15 electromagnetic classes have their
* <a href="../html_TestEm15/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm16 TestEm16
* The TestEm16 electromagnetic classes have their
* <a href="../html_TestEm16/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm17 TestEm17
* The TestEm17 electromagnetic classes have their
* <a href="../html_TestEm17/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @defgroup extended_electromagnetic_TestEm18 TestEm18
* The TestEm18 electromagnetic classes have their
* <a href="../html_TestEm18/html/index.html">standalone documentation </a>
* @ingroup extended_electromagnetic
* @{
*/
/** @} */
/** @} */
@@ -0,0 +1,18 @@
// $Id: Doxymodules_errorpropagation.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_errorpropagation.h
/// \brief The page that defines the extended/errorpropagation examples modules
/** @defgroup extended_errorpropagation errorpropagation
* Errorpropagation example
* @ingroup extended
* @{
*/
class ExErrorDetectorConstruction {};
class ExErrorDetectorMessenger {};
class ExErrorMagneticField {};
/** @} */
@@ -0,0 +1,135 @@
// $Id: Doxymodules_eventgenerator.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_eventgenerator.h
/// \brief The page that defines the extended/eventgenerator examples modules
/** @defgroup extended_eventgenerator eventgenerator
* Extended examples eventgenerator classes
* @{
*/
/** @defgroup extended_eventgenerator_exgps exgps
* Eventgenerator example exgps
* @ingroup extended_eventgenerator
* @{
*/
class exGPSAnalysisManager {};
class exGPSAnalysisMessenger {};
class exGPSEventAction {};
class exGPSEventActionMessenger {};
class exGPSGeometryConstruction {};
class exGPSPhysicsList {};
class exGPSPrimaryGeneratorAction {};
class exGPSRunAction {};
/** @} */
/** @defgroup extended_eventgenerator_HepMC HepMC
* Extended examples eventgenerator/HepMC
* @ingroup extended_eventgenerator
* @{
*/
/** @defgroup extended_eventgenerator_HepMC_HepMCEx01 HepMCEx01
* Eventgenerator HepMC example HepMCEx01
* @ingroup extended_eventgenerator_HepMC
* @{
*/
class ExN04CalorimeterHit {};
class ExN04CalorimeterParametrisation {};
class ExN04CalorimeterROGeometry {};
class ExN04CalorimeterSD {};
class ExN04DetectorConstruction {};
class ExN04DetectorParameterDef {};
class ExN04DummySD {};
class ExN04EventAction {};
class ExN04Field {};
class ExN04MuonHit {};
class ExN04MuonSD {};
class ExN04PrimaryGeneratorAction {};
class ExN04PrimaryGeneratorMessenger {};
class ExN04RunAction {};
class ExN04StackingAction {};
class ExN04StackingActionMessenger {};
class ExN04SteppingAction {};
class ExN04SteppingVerbose {};
class ExN04TrackerHit {};
class ExN04TrackerParametrisation {};
class ExN04TrackerSD {};
class ExN04TrackingAction {};
class HepMCG4AsciiReader {};
class HepMCG4AsciiReaderMessenger {};
class HepMCG4Interface {};
class HepMCG4PythiaInterface {};
class HepMCG4PythiaMessenger {};
/** @} */
/** @defgroup extended_eventgenerator_HepMC_HepMCEx02 HepMCEx02
* Eventgenerator HepMC example HepMCEx02
* @ingroup extended_eventgenerator_HepMC
* @{
*/
class H02DetectorConstruction {};
class H02EventAction {};
class H02Field {};
class H02MuonHit {};
class H02MuonSD {};
class H02PrimaryGeneratorAction {};
class H02PrimaryGeneratorMessenger {};
class H02SteppingAction {};
class HepMCG4AsciiReader {};
class HepMCG4AsciiReaderMessenger {};
class HepMCG4Interface {};
class HepMCG4PythiaInterface {};
class HepMCG4PythiaMessenger {};
/** @} */
/** @defgroup extended_eventgenerator_HepMC_MCTruth MCTruth
* Eventgenerator HepMC example MCTruth
* @ingroup extended_eventgenerator_HepMC
* @{
*/
class MCTruthConfig {};
class MCTruthEventAction {};
class MCTruthManager {};
class MCTruthTrackInformation {};
class MCTruthTrackingAction {};
/** @} */
/** @} */
/** @defgroup extended_eventgenerator_particleGun particleGun
* Eventgenerator example particleGun has its
* <a href="../html_particleGun/html/index.html">standalone documentation </a>
* @ingroup extended_eventgenerator
* @{
*/
/** @} */
/** @defgroup extended_eventgenerator_pythia_decayer6 pythia_decayer6
* Eventgenerator example pythia_decayer6
* @ingroup extended_eventgenerator
* @{
*/
enum EDecayType {};
class G4Pythia6Decayer {};
class G4Pythia6DecayerMessenger {};
class P6DExtDecayerPhysics {};
class P6DPhysicsList {};
class Pythia6 {};
/** @} */
/** @} */
@@ -0,0 +1,47 @@
// $Id: Doxymodules_exoticphysics.h 65679 2012-11-26 13:41:53Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_exoticphysics.h
/// \brief The page that defines the extended/exoticphysics examples modules
/** @defgroup extended_exoticphysics exoticphysics
* Extended examples eventgenerator classes
* @{
*/
/** @defgroup extended_exoticphysics_monopole monopole
* Exoticphysics monopole example has its
* <a href="../html_monopole/html/index.html">standalone documentation </a>
* @ingroup extended_exoticphysics
* @{
*/
/** @} */
/** @defgroup extended_exoticphysics_phonon phonon
* Exotic physics example phonon
* @ingroup extended_exoticphysics
* @{
*/
class XAlminumElectrodeHit {};
class XAlminumElectrodeSensitivity {};
class XDetectorConstruction {};
class XLatticeManager3 {};
class XLogicalLattice {};
class XLPhonon {};
class XPhononDownconversionProcess {};
class XPhononReflectionProcess {};
class XPhononScatteringProcess {};
class XPhononStackingAction {};
class XPhononTrackInformation {};
class XPhysicalLattice {};
class XPhysicsList {};
class XPrimaryGeneratorAction {};
class XTPhononFast {};
class XTPhononSlow {};
/** @} */
/** @} */
+170
View File
@@ -0,0 +1,170 @@
// $Id: Doxymodules_field.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_field.h
/// \brief The page that defines the extended/field examples modules
/** @defgroup extended_field field
* Extended examples field classes
* @{
*/
/** @defgroup extended_field_BlineTracer BlineTracer
* Field example BlineTracer
* @ingroup extended_field
* @{
*/
class G4BlineEquation {};
class G4BlineEventAction {};
class G4BlinePrimaryGeneratorAction {};
class G4BlineSteppingAction {};
class G4BlineTracer {};
class G4BlineTracerMessenger {};
/** @} */
/** @defgroup extended_field_field01 field01
* Field example field01
* @{
*/
class F01CalorHit {};
class F01CalorimeterSD {};
class F01DetectorConstruction {};
class F01DetectorMessenger {};
class F01EventAction {};
class F01EventActionMessenger {};
class F01FieldMessenger {};
class F01FieldSetup {};
class F01PhysicsList {};
class F01PhysicsListMessenger {};
class F01PrimaryGeneratorAction {};
class F01PrimaryGeneratorMessenger {};
class F01RunAction {};
class F01RunMessenger {};
class F01StepCut {};
class F01SteppingAction {};
class F01SteppingMessenger {};
class F01SteppingVerbose {};
/** @} */
/** @defgroup extended_field_field02 field02
* Field example field02
* @{
*/
class F02CalorHit {};
class F02CalorimeterSD {};
class F02DetectorConstruction {};
class F02DetectorMessenger {};
class F02ElectricFieldSetup {};
class F02EventAction {};
class F02EventActionMessenger {};
class F02FieldMessenger {};
class F02PhysicsList {};
class F02PhysicsListMessenger {};
class F02PrimaryGeneratorAction {};
class F02PrimaryGeneratorMessenger {};
class F02RunAction {};
class F02RunMessenger {};
class F02StepCut {};
class F02SteppingAction {};
class F02SteppingMessenger {};
class F02SteppingVerbose {};
/** @} */
/** @defgroup extended_field_field03 field03
* Field example field03
* @{
*/
class F03CalorHit {};
class F03CalorimeterSD {};
class F03DetectorConstruction {};
class F03DetectorMessenger {};
class F03EventAction {};
class F03EventActionMessenger {};
class F03FieldMessenger {};
class F03FieldSetup {};
class F03PhysicsList {};
class F03PhysicsListMessenger {};
class F03PrimaryGeneratorAction {};
class F03PrimaryGeneratorMessenger {};
class F03RunAction {};
class F03RunMessenger {};
class F03StepCut {};
class F03SteppingAction {};
class F03SteppingMessenger {};
class F03SteppingVerbose {};
/** @} */
/** @defgroup extended_field_field04 field04
* Field example field04
* @{
*/
class F04DetectorConstruction {};
class F04DetectorMessenger {};
class F04ElementField {};
class F04EventAction {};
class F04EventActionMessenger {};
class F04ExtraPhysics {};
class F04FieldMessenger {};
class F04FocusSolenoid {};
class F04GlobalField {};
class F04Materials {};
class F04OpticalPhysics {};
class F04PhysicsList {};
class F04PhysicsListMessenger {};
class F04PrimaryGeneratorAction {};
class F04PrimaryGeneratorMessenger {};
class F04RunAction {};
class F04RunActionMessenger {};
class F04SimpleSolenoid {};
class F04StackingAction {};
class F04StepMax {};
class F04SteppingAction {};
class F04SteppingActionMessenger {};
class F04SteppingVerbose {};
class F04TrackingAction {};
class F04Trajectory {};
class F04TrajectoryPoint {};
class F04UserTrackInformation {};
/** @} */
/** @defgroup extended_field_field05 field05
* Field example field05
* @{
*/
class F05DetectorConstruction {};
class F05ExtraPhysics {};
class F05Field {};
class F05PhysicsList {};
class F05PrimaryGeneratorAction {};
class F05SteppingAction {};
/** @} */
/** @defgroup extended_field_field06 field06
* Field example field06
* @{
*/
class F06DetectorConstruction {};
class F06EventAction {};
class F06EventActionMessenger {};
class F06ExtraPhysics {};
class F06Field {};
class F06PhysicsList {};
class F06PrimaryGeneratorAction {};
/** @} */
/** @} */
+22
View File
@@ -0,0 +1,22 @@
// $Id: Doxymodules_g3tog4.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_g3tog4.h
/// \brief The page that defines the extended/g3tog4 examples modules
/** @defgroup extended_g3tog4 g3tog4
* Extended examples g3tog4 classes
* @{
*/
/** @defgroup extended_g3tog4_clGeometry clGeometry
* g3tog4 example clGeometry
* @{
*/
class G3toG4DetectorConstruction {};
/** @} */
/** @} */
+43
View File
@@ -0,0 +1,43 @@
// $Id: Doxymodules_geometry.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_geometry.h
/// \brief The page that defines the extended/geometry examples modules
/** @defgroup extended_geometry geometry
* Extended examples geometry classes
* @{
*/
/** @defgroup extended_geometry_olap olap
* Geometry example olap
* @{
*/
class G4GeoNav {};
class OlapDetConstr {};
class OlapEventAction {};
class OlapGenerator {};
class OlapLogManager {};
class OlapManager {};
class OlapManagerMessenger {};
class OlapNotify {};
class OlapPhysicsList {};
class OlapRunAction {};
class OlapSteppingAction {};
class RandomDetector {};
class SolidAnalyser {};
class tree {};
/** @} */
/** @defgroup extended_geometry_transforms transforms
* Geometry example transforms has its
* <a href="../html_transforms/html/index.html">standalone documentation </a>
* @{
*/
/** @} */
/** @} */
+49
View File
@@ -0,0 +1,49 @@
// $Id: Doxymodules_hadronic.h 65679 2012-11-26 13:41:53Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_hadronic.h
/// \brief The page that defines the extended/hadronic examples modules
/** @defgroup extended_hadronic hadronic
* Extended examples hadronic classes
* @{
*/
/** @defgroup extended_hadronic_Hadr00 Hadr00
* The shared hadronic classes have their
* <a href="../html_Hadr00/html/index.html">standalone documentation </a>
* @ingroup extended_hadronic
* @{
*/
/** @} */
/** @defgroup extended_hadronic_Hadr01 Hadr01
* The shared hadronic classes have their
* <a href="../html_Hadr01/html/index.html">standalone documentation </a>
* @ingroup extended_hadronic
* @{
*/
/** @} */
/** @defgroup extended_hadronic_Hadr02 Hadr02
* The shared hadronic classes have their
* <a href="../html_Hadr02/html/index.html">standalone documentation </a>
* @ingroup extended_hadronic
* @{
*/
/** @} */
/** @defgroup extended_hadronic_Hadr03 Hadr03
* The shared hadronic classes have their
* <a href="../html_Hadr03/html/index.html">standalone documentation </a>
* @ingroup extended_hadronic
* @{
*/
/** @} */
/** @} */
+86
View File
@@ -0,0 +1,86 @@
// $Id: Doxymodules_medical.h 65679 2012-11-26 13:41:53Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_medical.h
/// \brief The page that defines the extended/medical examples modules
/** @defgroup extended_medical medical
* Extended medical examples classes
* @{
*/
/** @defgroup extended_medical_DICOM DICOM
* Medical example DICOM
* @ingroup extended_medical
* @{
*/
class DicomDetectorConstruction {};
class DicomEventAction {};
class DicomHandler {};
class DicomIntersectVolume {};
class DicomNestedParamDetectorConstruction {};
class DicomNestedPhantomParameterisation {};
class DicomPartialDetectorConstruction {};
class DicomPhantomParameterisationColour {};
class DicomPhantomZSliceHeader {};
class DicomPhysicsList {};
class DicomPrimaryGeneratorAction {};
class DicomRegularDetectorConstruction {};
class DicomRunAction {};
class DicomRun {};
class NestedParamDicomDetectorConstruction {};
class RegularDicomDetectorConstruction {};
/** @} */
/** @} */
/** @defgroup extended_medical_electronScattering electronScattering
* Medical electronScattering example has its
* <a href="../html_electronScattering/html/index.html">standalone documentation </a>
* @ingroup extended_medical
* @{
*/
/** @} */
/** @defgroup extended_medical_electronScattering2 electronScattering2
* Medical electronScattering2 example has its
* <a href="../html_electronScattering2/html/index.html">standalone documentation </a>
* @ingroup extended_medical
* @{
*/
/** @} */
/** @defgroup extended_medical_fanoCavity fanoCavity
* Medical fanoCavity example has its
* <a href="../html_fanoCavity/html/index.html">standalone documentation </a>
* @ingroup extended_medical
* @{
*/
/** @} */
/** @defgroup extended_medical_fanoCavity2 fanoCavity2
* Medical fanoCavity2 example has its
* <a href="../html_fanoCavity2/html/index.html">standalone documentation </a>
* @ingroup extended_medical
* @{
*/
/** @} */
/** @defgroup extended_medical_GammaTherapy GammaTherapy
* Medical GammaTherapy example has its
* <a href="../html_GammaTherapy/html/index.html">standalone documentation </a>
* @ingroup extended_medical
* @{
*/
/** @} */
/** @} */
+2 -2
View File
@@ -1,8 +1,8 @@
// $Id: Doxymodules_new.h 55087 2011-11-16 10:11:00Z gcosmo $
// $Id: Doxymodules_new.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_new.h
/// \brief The page that defines the class groups for examples documentation
/// \brief The page that defines the extended/new examples modules
/** @defgroup extended_new new
+81
View File
@@ -0,0 +1,81 @@
// $Id: Doxymodules_optical.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_optical.h
/// \brief The page that defines the extended/optical examples modules
/** @defgroup extended_optical optical
* Extended optical examples classes
* @{
*/
/** @defgroup extended_optical_LXe LXe
* Optical example LXe
* @ingroup extended_optical
* @{
*/
class LXeDetectorConstruction {};
class LXeDetectorMessenger {};
class LXeEMPhysics {};
class LXeEventAction {};
class LXeEventMessenger {};
class LXeGeneralPhysics {};
class LXeMainVolume {};
class LXeMuonPhysics {};
class LXePhysicsList {};
class LXePMTHit {};
class LXePMTSD {};
class LXePrimaryGeneratorAction {};
class LXeRunAction {};
class LXeScintHit {};
class LXeScintSD {};
class LXeStackingAction {};
class LXeSteppingAction {};
class LXeSteppingMessenger {};
class LXeSteppingVerbose {};
class LXeTrackingAction {};
class LXeTrajectory {};
class LXeUserEventInformation {};
class LXeUserTrackInformation {};
class LXeWLSFiber {};
class LXeWLSSlab {};
class RecorderBase {};
/** @} */
/** @defgroup extended_optical_wls wls
* Optical example wls
* @ingroup extended_optical
* @{
*/
class WLSDetectorConstruction {};
class WLSDetectorMessenger {};
class WLSEventAction {};
class WLSEventActionMessenger {};
class WLSExtraPhysics {};
class WLSMaterials {};
class WLSOpticalPhysics {};
class WLSPhotonDetHit {};
class WLSPhotonDetSD {};
class WLSPhysicsList {};
class WLSPhysicsListMessenger {};
class WLSPrimaryGeneratorAction {};
class WLSPrimaryGeneratorMessenger {};
class WLSRunAction {};
class WLSRunActionMessenger {};
class WLSStackingAction {};
class WLSStepMax {};
class WLSSteppingAction {};
class WLSSteppingActionMessenger {};
class WLSSteppingVerbose {};
class WLSTrackingAction {};
class WLSTrajectory {};
class WLSTrajectoryPoint {};
class WLSUserTrackInformation {};
/** @} */
/** @} */
+58
View File
@@ -0,0 +1,58 @@
// $Id: Doxymodules_parallel.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_parallel.h
/// \brief The page that defines the extended/parallel examples modules
/** @defgroup extended_parallel parallel
* Extended examples parallel classes
* @{
*/
/** @defgroup extended_parallel_MPI MPI
* Extended examples parallel MPI classes
* @{
*/
/** @defgroup extended_parallel_MPI_exMPI01 exMPI01
* Parallel MPI exMPI01 example has its
* <a href="../html_exMPI01/html/index.html">standalone documentation </a>
* @ingroup extended_parallel_MPI
* @{
*/
/** @} */
/** @defgroup extended_parallel_MPI_exMPI02 exMPI02
* Parallel MPI exMPI02 example has its
* <a href="../html_exMPI02/html/index.html">standalone documentation </a>
* @ingroup extended_parallel_MPI
* @{
*/
/** @} */
/** @} */
/** @defgroup extended_parallel_ParN02 ParN02
* Parallel ParN02 example has its
* <a href="../html_ParN02/html/index.html">standalone documentation </a>
* @ingroup extended_parallel
* @{
*/
/** @} */
/** @defgroup extended_parallel_ParN04 ParN04
* Parallel ParN04 example has its
* <a href="../html_ParN04/html/index.html">standalone documentation </a>
* @ingroup extended_parallel
* @{
*/
/** @} */
/** @} */
@@ -0,0 +1,30 @@
// $Id: Doxymodules_parameterisations.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_parameterisations.h
/// \brief The page that defines the extended/parameterisations examples modules
/** @defgroup extended_parameterisations parameterisations
* Extended examples parameterisations classes
* @{
*/
/** @defgroup extended_parameterisations_gflash gflash
* parameterisations example gflash
* @{
*/
class ExGflashDetectorConstruction {};
class ExGflashEventAction {};
class ExGflashHit {};
class ExGflashHitsCollection {};
class ExGflashMaterialManager {};
class ExGflashPhysicsList {};
class ExGflashPrimaryGeneratorAction {};
class ExGflashRunAction {};
class ExGflashSensitiveDetector {};
/** @} */
/** @} */
+135
View File
@@ -0,0 +1,135 @@
// $Id: Doxymodules_persistency.h 65679 2012-11-26 13:41:53Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_persistency.h
/// \brief The page that defines the extended/persistency examples modules
/** @defgroup extended_persistency persistency
* Extended examples persistency classes
* @{
*/
/** @defgroup extended_persistency_gdml gdml
* Extended examples persistency gdml classes
* @{
*/
/** @defgroup extended_persistency_gdml_G01 G01
* Persistency gdml example G01
* @ingroup extended_persistency_gdml
* @{
*/
class G01DetectorConstruction {};
class G01PhysicsList {};
class G01PrimaryGeneratorAction {};
/** @} */
/** @defgroup extended_persistency_gdml_G02 G02
* Persistency gdml example G02
* @ingroup extended_persistency_gdml
* @{
*/
class G02ChamberParameterisation {};
class G02DetectorConstruction {};
class G02DetectorMessenger {};
class G02PrimaryGeneratorAction {};
class G02RunAction {};
/** @} */
/** @defgroup extended_persistency_gdml_G03 G03
* Persistency gdml example G03
* @ingroup extended_persistency_gdml
* @{
*/
class G03ColorReader {};
class G03ColorWriter {};
class G03DetectorConstruction {};
class G03DetectorMessenger {};
class G03PrimaryGeneratorAction {};
class G03RunAction {};
/** @} */
/** @defgroup extended_persistency_gdml_G04 G04
* Persistency gdml example G04
* @ingroup extended_persistency_gdml
* @{
*/
class G04DetectorConstruction {};
class G04PhysicsList {};
class G04PrimaryGeneratorAction {};
class G04SensitiveDetector {};
/** @} */
/** @} */
/** @defgroup extended_persistency_P01 P01
* Persistency example P01
* @ingroup extended_persistency
* @{
*/
class Classes {};
class ExP01ChamberParameterisation {};
class ExP01DetectorConstruction {};
class ExP01DetectorMessenger {};
class ExP01EventAction {};
class ExP01MagneticField {};
class ExP01PhysicsList {};
class ExP01PrimaryGeneratorAction {};
class ExP01RunAction {};
class ExP01SteppingAction {};
class ExP01SteppingVerbose {};
class ExP01TrackerHit {};
class ExP01TrackerSD {};
class RootIO {};
/** @} */
/** @defgroup extended_persistency_P02 P02
* Persistency example P02
* @ingroup extended_persistency
* @{
*/
class ExP02Classes {};
class ExP02DetConstrReader {};
class ExP02DetectorConstruction {};
class ExP02GeoTree {};
class ExP02PhysicsList {};
class ExP02PrimaryGeneratorAction {};
/** @} */
/** @defgroup extended_persistency_P03 P03
* Persistency example P03
* @ingroup extended_persistency
* @{
*/
class ExTGDetectorConstruction {};
class ExTGDetectorConstructionWithCpp {};
class ExTGDetectorConstructionWithCuts {};
class ExTGDetectorConstructionWithSD {};
class ExTGPhysicsList {};
class ExTGPrimaryGeneratorAction {};
class ExTGRCDetectorBuilder {};
class ExTGRCLineProcessor {};
class ExTGRCRegionCutsMgr {};
class ExTGRCRegionData {};
class ExTGRunAction {};
class ExTGTrackerHit {};
class ExTGTrackerSD {};
/** @} */
/** @} */
@@ -0,0 +1,22 @@
// $Id: Doxymodules_polarisation.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_polarisation.h
/// \brief The page that defines the extended/polarisation examples modules
/** @defgroup extended_polarisation polarisation
* Extended examples eventgenerator classes
* @{
*/
/** @defgroup extended_polarisation_Pol01 Pol01
* polarisation Pol01 example has its
* <a href="../html_Pol01/html/index.html">standalone documentation </a>
* @ingroup extended_polarisation
* @{
*/
/** @} */
/** @} */
@@ -0,0 +1,31 @@
// $Id: Doxymodules_radioactivedecay.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_radioactivedecay.h
/// \brief The page that defines the extended/radioactivedecay examples modules
/** @defgroup extended_radioactivedecay radioactivedecay
* Extended examples eventgenerator classes
* @{
*/
/** @defgroup extended_radioactivedecay_rdecay01 rdecay01
* radioactivedecay rdecay01 example has its
* <a href="../html_rdecay01/html/index.html">standalone documentation </a>
* @ingroup extended_radioactivedecay
* @{
*/
/** @} */
/** @defgroup extended_radioactivedecay_rdecay02 rdecay02
* radioactivedecay rdecay02 example has its
* <a href="../html_rdecay02/html/index.html">standalone documentation </a>
* @ingroup extended_radioactivedecay
* @{
*/
/** @} */
/** @} */
+109
View File
@@ -0,0 +1,109 @@
// $Id: Doxymodules_runAndEvent.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_runAndEvent.h
/// \brief The page that defines the extended/runAndEvent examples modules
/** @defgroup extended_runAndEvent runAndEvent
* Extended runAndEvent examples classes
* @{
*/
/** @defgroup extended_runAndEvent_RE01 RE01
* RunAndEvent example RE01
* @ingroup extended_runAndEvent
* @{
*/
class RE01BosonPhysics {};
class RE01CalorimeterHit {};
class RE01CalorimeterParametrisation {};
class RE01CalorimeterROGeometry {};
class RE01CalorimeterSD {};
class RE01DecayPhysics {};
class RE01DetectorConstruction {};
class RE01DetectorParameterDef {};
class RE01DummySD {};
class RE01EventAction {};
class RE01Field {};
class RE01HadronPhysics {};
class RE01IonPhysics {};
class RE01LeptonPhysics {};
class RE01PhysicsList {};
class RE01PrimaryGeneratorAction {};
class RE01PrimaryGeneratorMessenger {};
class RE01RegionInformation {};
class RE01RunAction {};
class RE01StackingAction {};
class RE01SteppingAction {};
class RE01TrackerHit {};
class RE01TrackerParametrisation {};
class RE01TrackerSD {};
class RE01TrackInformation {};
class RE01TrackingAction {};
class RE01Trajectory {};
/** @} */
/** @defgroup extended_runAndEvent_RE02 RE02
* RunAndEvent example RE02
* @ingroup extended_runAndEvent
* @{
*/
class RE02DetectorConstruction {};
class RE02EMPhysics {};
class RE02EventAction {};
class RE02GeneralPhysics {};
class RE02HadronPhysics {};
class RE02IonPhysics {};
class RE02MuonPhysics {};
class RE02NestedPhantomParameterisation {};
class RE02PhysicsList {};
class RE02PrimaryGeneratorAction {};
class RE02PSCellFlux {};
class RE02PSEnergyDeposit {};
class RE02PSFlatSurfaceCurrent {};
class RE02PSFlatSurfaceFlux {};
class RE02PSNofStep {};
class RE02PSPassageCellFlux {};
class RE02RunAction {};
class RE02Run {};
/** @} */
/** @defgroup extended_runAndEvent_RE03 RE03
* RunAndEvent example RE03
* @ingroup extended_runAndEvent
* @{
*/
class RE03DetectorConstruction {};
class RE03PhysicsList {};
class RE03PrimaryGeneratorAction {};
class RE03UserScoreWriter {};
/** @} */
/** @defgroup extended_runAndEvent_RE04 RE04
* RunAndEvent example RE04
* @ingroup extended_runAndEvent
* @{
*/
class RE04DetectorConstruction {};
class RE04EventAction {};
class RE04ParallelWorldConstruction {};
class RE04ParallelWorldParam {};
class RE04PhysicsList {};
class RE04PrimaryGeneratorAction {};
class RE04SteppingAction {};
class RE04TrackingAction {};
class RE04Trajectory {};
class RE04TrajectoryPoint {};
/** @} */
/** @} */
@@ -0,0 +1,44 @@
// $Id: Doxymodules_visualization.h 60059 2012-06-27 13:00:49Z gcosmo $
// The example class categories definitions for Doxygen
/// \file Doxymodules_visualization.h
/// \brief The page that defines the extended/visualization examples modules
/** @defgroup extended_visualization visualization
* Extended visualization examples classes
* @{
*/
/** @defgroup extended_visualization_perspective perspective
* Visualization example perspective
* @ingroup extended_visualization
* @{
*/
class PerspectiveVisAction {};
class PerspectiveVisActionMessenger {};
/** @} */
/** @defgroup extended_visualization_standalone standalone
* Visualization example standalone
* @ingroup extended_visualization
* @{
*/
class StandaloneVisAction {};
/** @} */
/** @defgroup extended_visualization_userVisAction userVisAction
* visualization example userVisAction
* @ingroup extended_visualization
* @{
*/
class UVA_VisAction {};
/** @} */
/** @} */
+34
View File
@@ -0,0 +1,34 @@
$Id$
-------------------------------------------------------------------
=========================================================
Geant4 - an Object-Oriented Toolkit for Simulation in HEP
=========================================================
Configuration files for Examples Doxygen documentation
----------------------------------------------------------
This file should be used by the G4 example coordinator to briefly
summarize all major modifications introduced in the code and keep
track of all tags.
----------------------------------------------------------
* Reverse chronological order (last date on top), please *
----------------------------------------------------------
26/11/12 I.Hrivnacova (doxygen-V09-05-02)
- Updated Doxyfile for removing .README.HowToRunTestEm1
26/11/12 I.Hrivnacova (doxygen-V09-05-01)
- Completed extended examples
27/06/12 I.Hrivnacova (doxygen-V09-05-00)
- First tag on Doxygen configuration files which now included
extended examples in the generated documentation.
See README file how to process to generate complete examples
(basic & extended) documentation.
+15
View File
@@ -0,0 +1,15 @@
$Id:$
To generate Doxygen documentation for all examples:
1) Check in Doxyfile, Doxyfile_standalone the value of
STRIP_FROM_PATH variable and adjust it if needed
2) Generate documentation for all examples with unique class names
(alltogether):
doxygen >& doxygen.out
3) Generate documentation for examples with non-unique class names
(a standalone documentation will be generated for each example)
./generate_standalone.sh
+56
View File
@@ -0,0 +1,56 @@
#!/bin/sh
# Script to generate standalone Doxygen documentation
# for the examples with non unique class names.
CURDIR=`pwd`
BACK_PATH2="../../../.doxygen/doc"
BACK_PATH4="../../../../../.doxygen/doc"
# generate documentation
# {1} example directory
# {2} relative path from the example to the doc directory
generate() {
echo "processing ${1}"
cd ../extended/${1}
EXAMPLE_NAME=${PWD##*/}
# add directory if shared
if [ "${EXAMPLE_NAME}" = "shared" ]; then
cd ..
DIR_NAME=${PWD##*/}
EXAMPLE_NAME=${DIR_NAME}"_shared"
cd shared
fi
# detect use of classes from shared
ADD_SHARED=""
if [ -f SharedFilesList.txt ]; then
if [ "`grep SHARED_CLASSES_LIST SharedFilesList.txt`" = "SHARED_CLASSES_LIST" ]; then
ADD_SHARED="../shared"
fi
fi
# detect use of classes from common
ADD_COMMON=""
if [ -f SharedFilesList.txt ]; then
if [ "`grep COMMON_CLASSES_LIST SharedFilesList.txt`" = "COMMON_CLASSES_LIST" ]; then
ADD_COMMON="../../common ../../../common"
fi
fi
#echo "Generating Doxyfile for example: ${EXAMPLE_NAME}"
cat $CURDIR/Doxyfile_standalone | sed s/"EXAMPLE_NAME"/"${EXAMPLE_NAME}"/g | sed sY"BACK_PATH"Y"${2}"Yg | sed sY"ADD_SHARED"Y"${ADD_SHARED}"Yg | sed sY"ADD_COMMON"Y"${ADD_COMMON}"Yg > Doxyfile
doxygen >& $CURDIR/doxygen_${EXAMPLE_NAME}.out
rm Doxyfile
cd $CURDIR
}
# process examples in second level directory in extended
for DIR in analysis/shared analysis/AnaEx01 analysis/AnaEx02 analysis/AnaEx03 electromagnetic/TestEm0 electromagnetic/TestEm1 electromagnetic/TestEm2 electromagnetic/TestEm3 electromagnetic/TestEm4 electromagnetic/TestEm5 electromagnetic/TestEm6 electromagnetic/TestEm7 electromagnetic/TestEm8 electromagnetic/TestEm9 electromagnetic/TestEm10 electromagnetic/TestEm11 electromagnetic/TestEm12 electromagnetic/TestEm13 electromagnetic/TestEm14 electromagnetic/TestEm15 electromagnetic/TestEm16 electromagnetic/TestEm17 electromagnetic/TestEm18 eventgenerator/particleGun exoticphysics/monopole geometry/transforms hadronic/Hadr00 hadronic/Hadr01 hadronic/Hadr02 hadronic/Hadr03 medical/electronScattering medical/electronScattering2 medical/fanoCavity medical/fanoCavity2 medical/GammaTherapy parallel/ParN02 parallel/ParN04 polarisation/Pol01 radioactivedecay/rdecay01 radioactivedecay/rdecay02; do
generate ${DIR} ${BACK_PATH2}
done
# process examples in fourth level directory in extended
for DIR in parallel/MPI/examples/exMPI01 parallel/MPI/examples/exMPI02; do
generate ${DIR} ${BACK_PATH4}
done
cd $CURDIR