Import Geant4 11.0.0 source tree
This commit is contained in:
Gabriele Cosmo
committed by
Ben Morgan
Ben Morgan
parent
6399a014b6
commit
80e2389dd8
@@ -1,24 +0,0 @@
|
||||
|
||||
///\file ".README.HowToNavigate.txt"
|
||||
///\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.
|
||||
|
||||
*/
|
||||
@@ -1,25 +0,0 @@
|
||||
|
||||
///\file ".README.novice.txt"
|
||||
///\brief Geant4 Old Novice Examples README page
|
||||
|
||||
/*! \page README_novice Old Novice Examples
|
||||
|
||||
The old "novice" set of examples is now replaced with a new "basic" set,
|
||||
covering the most typical use-cases of a Geant4 application with keeping
|
||||
simplicity and ease of use.
|
||||
|
||||
The source code of the last version of the novice examples set
|
||||
(in 9.6.p02 release) can be viewed in
|
||||
<a href="http://www-geant4.kek.jp/lxr/source/examples/novice/?v=9.6.p2">
|
||||
the Geant4 LXR code browser </a>
|
||||
|
||||
The new location of each example in 10.0 release:
|
||||
- N01 - removed
|
||||
- N02 - \link ExampleB2 basic/B2 \endlink
|
||||
- N03 - \link ExampleB4 basic/B4 \endlink
|
||||
- N04 - \link ExampleRE05 extended/runAndEvent/RE05 \endlink
|
||||
- N05 - \link ExamplePar01 extended/parameterisations/Par01 \endlink
|
||||
- N06 - \link ExampleOpNovice extended/optical/OpNovice \endlink
|
||||
- N07 - \link ExampleRE06 extended/runAndEvent/RE06 \endlink
|
||||
|
||||
*/
|
||||
+56
-46
@@ -795,9 +795,6 @@ INPUT = Doxymain.h \
|
||||
../extended/analysis/.README.txt \
|
||||
../extended/analysis/AnaEx01/.README.txt \
|
||||
../extended/analysis/AnaEx02/.README.txt \
|
||||
../extended/analysis/AnaEx03/.README.txt \
|
||||
../extended/analysis/AnaEx03/.README.AIDA.txt \
|
||||
../extended/analysis/AnaEx03/.README.OpenScientist.txt \
|
||||
../extended/analysis/B1Con \
|
||||
../extended/biasing \
|
||||
../extended/electromagnetic/.README.txt \
|
||||
@@ -830,6 +827,7 @@ INPUT = Doxymain.h \
|
||||
../extended/eventgenerator/particleGun/.README.txt \
|
||||
../extended/eventgenerator/pythia/.README.txt \
|
||||
../extended/eventgenerator/pythia/decayer6 \
|
||||
../extended/eventgenerator/pythia/py8decayer/.README.txt \
|
||||
../extended/eventgenerator/userPrimaryGenerator/.README.txt \
|
||||
../extended/exoticphysics/.README.txt \
|
||||
../extended/exoticphysics/channeling/.README.txt \
|
||||
@@ -842,16 +840,19 @@ INPUT = Doxymain.h \
|
||||
../extended/g3tog4 \
|
||||
../extended/geometry/.README.txt \
|
||||
../extended/geometry/transforms/.README.txt \
|
||||
../extended/geometry/vecGeomNavigation \
|
||||
../extended/hadronic/.README.txt \
|
||||
../extended/hadronic/Hadr00/.README.txt \
|
||||
../extended/hadronic/Hadr01/.README.txt \
|
||||
../extended/hadronic/Hadr02/.README.txt \
|
||||
../extended/hadronic/Hadr03/.README.txt \
|
||||
../extended/hadronic/Hadr04/.README.txt \
|
||||
../extended/hadronic/Hadr05/.README.txt \
|
||||
../extended/hadronic/Hadr06/.README.txt \
|
||||
../extended/hadronic/Hadr07/.README.txt \
|
||||
../extended/hadronic/Hadr08/.README.txt \
|
||||
../extended/hadronic/Hadr09/.README.txt \
|
||||
../extended/hadronic/Hadr10/.README.txt \
|
||||
../extended/hadronic/FissionFragment \
|
||||
../extended/hadronic/NeutronSource/.README.txt \
|
||||
../extended/medical/.README.txt \
|
||||
@@ -863,6 +864,7 @@ INPUT = Doxymain.h \
|
||||
../extended/medical/fanoCavity2/.README.txt \
|
||||
../extended/medical/GammaTherapy/.README.txt \
|
||||
../extended/medical/dna/.README.txt \
|
||||
../extended/medical/dna/AuNP/.README.txt \
|
||||
../extended/medical/dna/chem1/.README.txt \
|
||||
../extended/medical/dna/chem2/.README.txt \
|
||||
../extended/medical/dna/chem3/.README.txt \
|
||||
@@ -880,6 +882,7 @@ INPUT = Doxymain.h \
|
||||
../extended/medical/dna/neuron/.README.txt \
|
||||
../extended/medical/dna/pdb4dna/.README.txt \
|
||||
../extended/medical/dna/range/.README.txt \
|
||||
../extended/medical/dna/scavenger \
|
||||
../extended/medical/dna/slowing/.README.txt \
|
||||
../extended/medical/dna/splitting/.README.txt \
|
||||
../extended/medical/dna/spower/.README.txt \
|
||||
@@ -916,7 +919,14 @@ INPUT = Doxymain.h \
|
||||
../extended/radioactivedecay/Activation/.README.txt \
|
||||
../extended/radioactivedecay/rdecay01/.README.txt \
|
||||
../extended/radioactivedecay/rdecay02/.README.txt \
|
||||
../extended/runAndEvent \
|
||||
../extended/runAndEvent/.README.txt \
|
||||
../extended/runAndEvent/RE01 \
|
||||
../extended/runAndEvent/RE02 \
|
||||
../extended/runAndEvent/RE03 \
|
||||
../extended/runAndEvent/RE04 \
|
||||
../extended/runAndEvent/RE05 \
|
||||
../extended/runAndEvent/RE06 \
|
||||
../extended/runAndEvent/RE07/.README.txt \
|
||||
../extended/visualization \
|
||||
.README.novice.txt
|
||||
|
||||
@@ -957,48 +967,48 @@ RECURSIVE = YES
|
||||
# Note that relative paths are relative to the directory from which doxygen is
|
||||
# run.
|
||||
|
||||
EXCLUDE = ../basic/B2/B2b/include/B2ActionInitialization.hh \
|
||||
../basic/B2/B2b/include/B2EventAction.hh \
|
||||
../basic/B2/B2b/include/B2FieldMessenger.hh \
|
||||
../basic/B2/B2b/include/B2MagneticField.hh \
|
||||
../basic/B2/B2b/include/B2PrimaryGeneratorAction.hh \
|
||||
../basic/B2/B2b/include/B2RunAction.hh \
|
||||
../basic/B2/B2b/include/B2TrackerHit.hh \
|
||||
../basic/B2/B2b/include/B2TrackerSD.hh \
|
||||
../basic/B2/B2b/src/B2ActionInitialization.cc \
|
||||
../basic/B2/B2b/src/B2EventAction.cc \
|
||||
../basic/B2/B2b/src/B2FieldMessenger.cc \
|
||||
../basic/B2/B2b/src/B2MagneticField.cc \
|
||||
../basic/B2/B2b/src/B2PrimaryGeneratorAction.cc \
|
||||
../basic/B2/B2b/src/B2RunAction.cc \
|
||||
../basic/B2/B2b/src/B2TrackerHit.cc \
|
||||
../basic/B2/B2b/src/B2TrackerSD.cc \
|
||||
../basic/B3/B3b/include/B3Analysis.hh \
|
||||
../basic/B3/B3b/include/B3DetectorConstruction.hh \
|
||||
../basic/B3/B3b/include/B3PhysicsList.hh \
|
||||
../basic/B3/B3b/include/B3PrimaryGeneratorAction.hh \
|
||||
../basic/B3/B3b/include/B3StackingAction.hh \
|
||||
../basic/B3/B3b/src/B3DetectorConstruction.cc \
|
||||
../basic/B3/B3b/src/B3PhysicsList.cc \
|
||||
../basic/B3/B3b/src/B3PrimaryGeneratorAction.cc \
|
||||
../basic/B3/B3b/src/B3StackingAction.cc \
|
||||
../basic/B4/B4b/include/B4Analysis.hh \
|
||||
../basic/B4/B4c/include/B4Analysis.hh \
|
||||
../basic/B4/B4d/include/B4Analysis.hh \
|
||||
../basic/B4/B4b/include/B4DetectorConstruction.hh \
|
||||
../basic/B4/B4b/include/B4DetectorMessenger.hh \
|
||||
../basic/B4/B4b/src/B4DetectorConstruction.cc \
|
||||
../basic/B4/B4b/src/B4DetectorMessenger.cc \
|
||||
../basic/B4/B4b/include/B4PrimaryGeneratorAction.hh \
|
||||
../basic/B4/B4c/include/B4PrimaryGeneratorAction.hh \
|
||||
../basic/B4/B4d/include/B4PrimaryGeneratorAction.hh \
|
||||
../basic/B4/B4b/src/B4PrimaryGeneratorAction.cc \
|
||||
../basic/B4/B4c/src/B4PrimaryGeneratorAction.cc \
|
||||
../basic/B4/B4d/src/B4PrimaryGeneratorAction.cc \
|
||||
../basic/B4/B4c/include/B4RunAction.hh \
|
||||
../basic/B4/B4d/include/B4RunAction.hh \
|
||||
../basic/B4/B4c/src/B4RunAction.cc \
|
||||
../basic/B4/B4d/src/B4RunAction.cc \
|
||||
EXCLUDE = ../basic/B2/B2b/include/ActionInitialization.hh \
|
||||
../basic/B2/B2b/include/EventAction.hh \
|
||||
../basic/B2/B2b/include/FieldMessenger.hh \
|
||||
../basic/B2/B2b/include/MagneticField.hh \
|
||||
../basic/B2/B2b/include/PrimaryGeneratorAction.hh \
|
||||
../basic/B2/B2b/include/RunAction.hh \
|
||||
../basic/B2/B2b/include/TrackerHit.hh \
|
||||
../basic/B2/B2b/include/TrackerSD.hh \
|
||||
../basic/B2/B2b/src/ActionInitialization.cc \
|
||||
../basic/B2/B2b/src/EventAction.cc \
|
||||
../basic/B2/B2b/src/FieldMessenger.cc \
|
||||
../basic/B2/B2b/src/MagneticField.cc \
|
||||
../basic/B2/B2b/src/PrimaryGeneratorAction.cc \
|
||||
../basic/B2/B2b/src/RunAction.cc \
|
||||
../basic/B2/B2b/src/TrackerHit.cc \
|
||||
../basic/B2/B2b/src/TrackerSD.cc \
|
||||
../basic/B3/B3b/include/Analysis.hh \
|
||||
../basic/B3/B3b/include/DetectorConstruction.hh \
|
||||
../basic/B3/B3b/include/PhysicsList.hh \
|
||||
../basic/B3/B3b/include/PrimaryGeneratorAction.hh \
|
||||
../basic/B3/B3b/include/StackingAction.hh \
|
||||
../basic/B3/B3b/src/DetectorConstruction.cc \
|
||||
../basic/B3/B3b/src/PhysicsList.cc \
|
||||
../basic/B3/B3b/src/PrimaryGeneratorAction.cc \
|
||||
../basic/B3/B3b/src/StackingAction.cc \
|
||||
../basic/B4/B4b/include/Analysis.hh \
|
||||
../basic/B4/B4c/include/Analysis.hh \
|
||||
../basic/B4/B4d/include/Analysis.hh \
|
||||
../basic/B4/B4b/include/DetectorConstruction.hh \
|
||||
../basic/B4/B4b/include/DetectorMessenger.hh \
|
||||
../basic/B4/B4b/src/DetectorConstruction.cc \
|
||||
../basic/B4/B4b/src/DetectorMessenger.cc \
|
||||
../basic/B4/B4b/include/PrimaryGeneratorAction.hh \
|
||||
../basic/B4/B4c/include/PrimaryGeneratorAction.hh \
|
||||
../basic/B4/B4d/include/PrimaryGeneratorAction.hh \
|
||||
../basic/B4/B4b/src/PrimaryGeneratorAction.cc \
|
||||
../basic/B4/B4c/src/PrimaryGeneratorAction.cc \
|
||||
../basic/B4/B4d/src/PrimaryGeneratorAction.cc \
|
||||
../basic/B4/B4c/include/RunAction.hh \
|
||||
../basic/B4/B4d/include/RunAction.hh \
|
||||
../basic/B4/B4c/src/RunAction.cc \
|
||||
../basic/B4/B4d/src/RunAction.cc \
|
||||
../extended/analysis/B1Con/include/B1DetectorConstruction.hh \
|
||||
../extended/analysis/B1Con/include/B1EventAction.hh \
|
||||
../extended/analysis/B1Con/include/B1EventInformation.hh \
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
/*! \mainpage Geant4 Examples
|
||||
|
||||
This module collects four sets of user examples aimed to demonstrate to
|
||||
This module collects three 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.
|
||||
|
||||
@@ -27,15 +27,6 @@
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @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_B1Con B1Con
|
||||
* Analysis example B1Con
|
||||
* @ingroup extended_analysis
|
||||
|
||||
@@ -16,13 +16,13 @@
|
||||
* @{
|
||||
*/
|
||||
|
||||
class B1ActionInitialization{};
|
||||
class B1DetectorConstruction{};
|
||||
class B1EventAction{};
|
||||
class B1PrimaryGeneratorAction{};
|
||||
class B1Run{};
|
||||
class B1RunAction{};
|
||||
class B1SteppingAction{};
|
||||
class B1::ActionInitialization{};
|
||||
class B1::DetectorConstruction{};
|
||||
class B1::EventAction{};
|
||||
class B1::PrimaryGeneratorAction{};
|
||||
class B1::Run{};
|
||||
class B1::RunAction{};
|
||||
class B1::SteppingAction{};
|
||||
|
||||
/** @} */
|
||||
|
||||
@@ -38,14 +38,14 @@
|
||||
* @{
|
||||
*/
|
||||
|
||||
class B2ActionInitialization{};
|
||||
class B2aDetectorConstruction{};
|
||||
class B2aDetectorMessenger{};
|
||||
class B2EventAction{};
|
||||
class B2PrimaryGeneratorAction{};
|
||||
class B2RunAction{};
|
||||
class B2TrackerHit{};
|
||||
class B2TrackerSD{};
|
||||
class B2::ActionInitialization{};
|
||||
class B2::EventAction{};
|
||||
class B2::PrimaryGeneratorAction{};
|
||||
class B2::RunAction{};
|
||||
class B2::TrackerHit{};
|
||||
class B2::TrackerSD{};
|
||||
class B2a::DetectorConstruction{};
|
||||
class B2a::DetectorMessenger{};
|
||||
|
||||
/** @} */
|
||||
|
||||
@@ -55,15 +55,15 @@
|
||||
* @{
|
||||
*/
|
||||
|
||||
class B2ActionInitialization{};
|
||||
class B2bChamberParameterisation{};
|
||||
class B2bDetectorConstruction{};
|
||||
class B2bDetectorMessenger{};
|
||||
class B2EventAction{};
|
||||
class B2PrimaryGeneratorAction{};
|
||||
class B2RunAction{};
|
||||
class B2TrackerHit{};
|
||||
class B2TrackerSD{};
|
||||
class B2::ActionInitialization{};
|
||||
class B2::EventAction{};
|
||||
class B2::PrimaryGeneratorAction{};
|
||||
class B2::RunAction{};
|
||||
class B2::TrackerHit{};
|
||||
class B2::TrackerSD{};
|
||||
class B2b::ChamberParameterisation{};
|
||||
class B2b::DetectorConstruction{};
|
||||
class B2b::DetectorMessenger{};
|
||||
|
||||
/** @} */
|
||||
|
||||
@@ -81,13 +81,13 @@
|
||||
* @{
|
||||
*/
|
||||
|
||||
class B3aActionInitialization{};
|
||||
class B3aEventAction{};
|
||||
class B3aRunAction{};
|
||||
class B3DetectorConstruction{};
|
||||
class B3PhysicsList{};
|
||||
class B3PrimaryGeneratorAction{};
|
||||
class B3StackingAction{};
|
||||
class B3::DetectorConstruction{};
|
||||
class B3::PhysicsList{};
|
||||
class B3::PrimaryGeneratorAction{};
|
||||
class B3::StackingAction{};
|
||||
class B3a::ActionInitialization{};
|
||||
class B3a::EventAction{};
|
||||
class B3a::RunAction{};
|
||||
|
||||
/** @} */
|
||||
|
||||
@@ -97,13 +97,13 @@
|
||||
* @{
|
||||
*/
|
||||
|
||||
class B3bActionInitialization{};
|
||||
class B3bRun{};
|
||||
class B3bRunAction{};
|
||||
class B3DetectorConstruction{};
|
||||
class B3PhysicsList{};
|
||||
class B3PrimaryGeneratorAction{};
|
||||
class B3StackingAction{};
|
||||
class B3::PhysicsList{};
|
||||
class B3::PrimaryGeneratorAction{};
|
||||
class B3::StackingAction{};
|
||||
class B3b::ActionInitialization{};
|
||||
class B3b::Run{};
|
||||
class B3b::RunAction{};
|
||||
class B3D::etectorConstruction{};
|
||||
|
||||
/** @} */
|
||||
|
||||
@@ -122,12 +122,12 @@
|
||||
* @{
|
||||
*/
|
||||
|
||||
class B4aActionInitialization{};
|
||||
class B4aEventAction{};
|
||||
class B4aSteppingAction{};
|
||||
class B4DetectorConstruction{};
|
||||
class B4PrimaryGeneratorAction{};
|
||||
class B4RunAction{};
|
||||
class B4::DetectorConstruction{};
|
||||
class B4::PrimaryGeneratorAction{};
|
||||
class B4::RunAction{};
|
||||
class B4a::ActionInitialization{};
|
||||
class B4a::EventAction{};
|
||||
class B4a::SteppingAction{};
|
||||
|
||||
/** @} */
|
||||
|
||||
@@ -138,13 +138,13 @@
|
||||
* @{
|
||||
*/
|
||||
|
||||
class B4bActionInitialization{};
|
||||
class B4bEventAction{};
|
||||
class B4bRunAction{};
|
||||
class B4bRunData{};
|
||||
class B4bSteppingAction{};
|
||||
class B4DetectorConstruction{};
|
||||
class B4PrimaryGeneratorAction{};
|
||||
class B4::DetectorConstruction{};
|
||||
class B4::PrimaryGeneratorAction{};
|
||||
class B4b::ActionInitialization{};
|
||||
class B4b::EventAction{};
|
||||
class B4b::RunAction{};
|
||||
class B4b::RunData{};
|
||||
class B4b::SteppingAction{};
|
||||
|
||||
/** @} */
|
||||
|
||||
@@ -154,13 +154,13 @@
|
||||
* @{
|
||||
*/
|
||||
|
||||
class B4cActionInitialization{};
|
||||
class B4cCalorHit{};
|
||||
class B4cCalorimeterSD{};
|
||||
class B4cDetectorConstruction{};
|
||||
class B4cEventAction{};
|
||||
class B4PrimaryGeneratorAction{};
|
||||
class B4RunAction{};
|
||||
class B4::PrimaryGeneratorAction{};
|
||||
class B4::RunAction{};
|
||||
class B4c::ActionInitialization{};
|
||||
class B4c::CalorHit{};
|
||||
class B4c::CalorimeterSD{};
|
||||
class B4c::DetectorConstruction{};
|
||||
class B4c::EventAction{};
|
||||
|
||||
/** @} */
|
||||
|
||||
@@ -171,11 +171,11 @@
|
||||
* @{
|
||||
*/
|
||||
|
||||
class B4dActionInitialization{};
|
||||
class B4dDetectorConstruction{};
|
||||
class B4dEventAction{};
|
||||
class B4PrimaryGeneratorAction{};
|
||||
class B4RunAction{};
|
||||
class B4::PrimaryGeneratorAction{};
|
||||
class B4::RunAction{};
|
||||
class B4d::ActionInitialization{};
|
||||
class B4d::DetectorConstruction{};
|
||||
class B4d::EventAction{};
|
||||
|
||||
/** @} */
|
||||
|
||||
@@ -187,22 +187,23 @@
|
||||
* @{
|
||||
*/
|
||||
|
||||
class B5ActionInitialization{};
|
||||
class B5CellParameterisation{};
|
||||
class B5DetectorConstruction{};
|
||||
class B5DriftChamberHit{};
|
||||
class B5DriftChamberSD{};
|
||||
class B5EmCalorimeterHit{};
|
||||
class B5EmCalorimeterSD{};
|
||||
class B5EventAction{};
|
||||
class B5HadCalorimeterHit{};
|
||||
class B5HadCalorimeterSD{};
|
||||
class B5HodoscopeHit{};
|
||||
class B5HodoscopeSD{};
|
||||
class B5MagneticField{};
|
||||
class B5PrimaryGeneratorAction{};
|
||||
class B5RunAction{};
|
||||
class B5::ActionInitialization{};
|
||||
class B5::CellParameterisation{};
|
||||
class B5::DetectorConstruction{};
|
||||
class B5::DriftChamberHit{};
|
||||
class B5::DriftChamberSD{};
|
||||
class B5::EmCalorimeterHit{};
|
||||
class B5::EmCalorimeterSD{};
|
||||
class B5::EventAction{};
|
||||
class B5::HadCalorimeterHit{};
|
||||
class B5::HadCalorimeterSD{};
|
||||
class B5::HodoscopeHit{};
|
||||
class B5::HodoscopeSD{};
|
||||
class B5::MagneticField{};
|
||||
class B5::PrimaryGeneratorAction{};
|
||||
class B5::RunAction{};
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @} */
|
||||
|
||||
|
||||
@@ -118,6 +118,15 @@
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @defgroup extended_eventgenerator_pythia_py8decayer py8decayer
|
||||
* Eventgenerator example pythia_py8decayer has its
|
||||
* <a href="../html_py8decayer/html/index.html">standalone documentation </a>
|
||||
* @ingroup extended_eventgenerator
|
||||
* @{
|
||||
*/
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @defgroup extended_eventgenerator_userPrimaryGenerator userPrimaryGenerator
|
||||
* Eventgenerator example userPrimaryGenerator has its
|
||||
* <a href="../html_userPrimaryGenerator/html/index.html">standalone documentation </a>
|
||||
|
||||
@@ -17,4 +17,17 @@
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @defgroup extended_geometry_vecGeomNavigation vecGeomNavigation
|
||||
* Geometry example vecGeomNavigation
|
||||
* @{
|
||||
*/
|
||||
|
||||
class VG01ActionInitialization{};
|
||||
class VG01DetectorConstruction{};
|
||||
class VG01DetectorMessenger{};
|
||||
class VG01PrimaryGeneratorAction{};
|
||||
class VG01SteppingVerboseWithDir{};
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @} */
|
||||
|
||||
@@ -54,6 +54,15 @@
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @defgroup extended_hadronic_Hadr05 Hadr05
|
||||
* The Hadr05 hadronic classes have their
|
||||
* <a href="../html_Hadr05/html/index.html">standalone documentation </a>
|
||||
* @ingroup extended_hadronic
|
||||
* @{
|
||||
*/
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @defgroup extended_hadronic_Hadr06 Hadr06
|
||||
* The Hadr06 hadronic classes have their
|
||||
* <a href="../html_Hadr06/html/index.html">standalone documentation </a>
|
||||
@@ -92,6 +101,15 @@
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @defgroup extended_hadronic_Hadr10 Hadr10
|
||||
* The Hadr10 hadronic classes have their
|
||||
* <a href="../html_Hadr10/html/index.html">standalone documentation </a>
|
||||
* @ingroup extended_hadronic
|
||||
* @{
|
||||
*/
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @defgroup extended_hadronic_FissionFragment FissionFragment
|
||||
* Hadronic example FissionFragment
|
||||
* @ingroup extended_hadronic
|
||||
|
||||
@@ -284,6 +284,27 @@
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @defgroup extended_medical_dna_scavenger scavenger
|
||||
* Medical dna scavenger example
|
||||
* @ingroup extended_medical_dna
|
||||
* @{
|
||||
*/
|
||||
|
||||
class scavenger::ActionInitialization{};
|
||||
class scavenger::DetectorConstruction{};
|
||||
class scavenger::EmDNAChemistry{};
|
||||
class scavenger::ParserChemReaction{};
|
||||
class scavenger::PhysicsList{};
|
||||
class scavenger::PrimaryGeneratorAction{};
|
||||
class scavenger::PrimaryKiller{};
|
||||
class scavenger::Run{};
|
||||
class scavenger::RunAction{};
|
||||
class scavenger::ScoreSpecies{};
|
||||
class scavenger::StackingAction{};
|
||||
class scavenger::TimeStepAction{};
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @defgroup extended_medical_dna_splitting splitting
|
||||
* Medical dna splitting example has its
|
||||
* <a href="../html_splitting/html/index.html">standalone documentation </a>
|
||||
|
||||
@@ -145,4 +145,15 @@
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @defgroup extended_runAndEvent_RE07 RE07
|
||||
* RunAndEvent example RE07
|
||||
* The RE07 example classes have their
|
||||
* <a href="../html_RE07/html/index.html">standalone documentation </a>
|
||||
* @ingroup extended_runAndEvent
|
||||
* @ingroup extended_electromagnetic
|
||||
* @{
|
||||
*/
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @} */
|
||||
|
||||
@@ -17,6 +17,21 @@ track of all tags.
|
||||
* Reverse chronological order (last date on top), please *
|
||||
----------------------------------------------------------
|
||||
|
||||
06/12/20 I.Hrivnacova (doxygen-V10-07-02)
|
||||
- Added new extended example RE07 in documentation
|
||||
|
||||
29/11/20 I.Hrivnacova (doxygen-V10-07-01)
|
||||
- Updated for removing AnaEx03
|
||||
|
||||
7/11/20 I.Hrivnacova (doxygen-V10-07-00)
|
||||
- Added new extended examples in documentation:
|
||||
- eventgenerator/pythia/py8decayer
|
||||
- geometry/vecGeomNavigation
|
||||
- hadronic/Hadr05
|
||||
- hadronic/Hadr10
|
||||
- medical/dna/AuNP
|
||||
- medical/dna/scavenger
|
||||
|
||||
9/11/20 I.Hrivnacova (doxygen-V10-06-03)
|
||||
- Added new extended example Hadr09 in documentation
|
||||
|
||||
|
||||
@@ -1,25 +0,0 @@
|
||||
|
||||
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) Download geant4.tag file from:
|
||||
http://www-geant4.kek.jp/Reference/10.01/geant4.tag
|
||||
and update the version number in TAGFILES value
|
||||
in Doxyfile, Doxyfile_standalone
|
||||
|
||||
3) Generate documentation for all examples with unique class names
|
||||
(alltogether):
|
||||
doxygen >& doxygen.out
|
||||
|
||||
4) Generate documentation for examples with non-unique class names
|
||||
(a standalone documentation will be generated for each example)
|
||||
./generate_standalone.sh
|
||||
|
||||
To extract coding guildelines violations from Doxygen output
|
||||
(requires using patched Doxygen):
|
||||
|
||||
cat doxygen*.out | grep "### Geant4 guidelines violation: data member" >> data_members_violations.txt
|
||||
cat doxygen*.out | grep "### Geant4 guidelines violation: function member" >> function_members_violations.txt
|
||||
|
||||
@@ -47,12 +47,12 @@ generate() {
|
||||
}
|
||||
|
||||
# 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 eventgenerator/exgps eventgenerator/userPrimaryGenerator exoticphysics/channeling exoticphysics/dmparticle exoticphysics/monopole geometry/transforms hadronic/Hadr00 hadronic/Hadr01 hadronic/Hadr02 hadronic/Hadr03 hadronic/Hadr04 hadronic/Hadr06 hadronic/Hadr07 hadronic/Hadr08 hadronic/Hadr09 hadronic/NeutronSource medical/electronScattering medical/electronScattering2 medical/fanoCavity medical/fanoCavity2 medical/GammaTherapy optical/OpNovice2 physicslists/extensibleFactory physicslists/factory physicslists/genericPL polarisation/Pol01 radioactivedecay/Activation radioactivedecay/rdecay01 radioactivedecay/rdecay02; do
|
||||
for DIR in analysis/shared analysis/AnaEx01 analysis/AnaEx02 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 eventgenerator/exgps eventgenerator/userPrimaryGenerator exoticphysics/channeling exoticphysics/dmparticle exoticphysics/monopole geometry/transforms hadronic/Hadr00 hadronic/Hadr01 hadronic/Hadr02 hadronic/Hadr03 hadronic/Hadr04 hadronic/Hadr05 hadronic/Hadr06 hadronic/Hadr07 hadronic/Hadr08 hadronic/Hadr09 hadronic/Hadr10 hadronic/NeutronSource medical/electronScattering medical/electronScattering2 medical/fanoCavity medical/fanoCavity2 medical/GammaTherapy optical/OpNovice2 physicslists/extensibleFactory physicslists/factory physicslists/genericPL polarisation/Pol01 radioactivedecay/Activation radioactivedecay/rdecay01 radioactivedecay/rdecay02 runAndEvent/RE07; do
|
||||
generate ${DIR} ${BACK_PATH2}
|
||||
done
|
||||
|
||||
# process examples in third level directory in extended
|
||||
for DIR in eventgenerator/HepMC/MCTruth medical/dna/chem1 medical/dna/chem2 medical/dna/chem3 medical/dna/chem4 medical/dna/chem5 medical/dna/chem6 medical/dna/clustering medical/dna/dnadamage1 medical/dna/dnaphysics medical/dna/icsd medical/dna/mfp medical/dna/microdosimetry medical/dna/microprox medical/dna/microyz medical/dna/neuron medical/dna/pdb4dna medical/dna/range medical/dna/slowing medical/dna/splitting medical/dna/spower medical/dna/svalue medical/dna/wholeNuclearDNA medical/dna/wvalue parameterisations/gflash/gflasha parallel/TopC/ParN02 parallel/TopC/ParN04; do
|
||||
for DIR in eventgenerator/HepMC/MCTruth eventgenerator/pythia/py8decayer medical/dna/chem1 medical/dna/chem2 medical/dna/chem3 medical/dna/chem4 medical/dna/chem5 medical/dna/chem6 medical/dna/clustering medical/dna/dnadamage1 medical/dna/dnaphysics medical/dna/icsd medical/dna/mfp medical/dna/microdosimetry medical/dna/microprox medical/dna/microyz medical/dna/neuron medical/dna/pdb4dna medical/dna/range medical/dna/slowing medical/dna/splitting medical/dna/spower medical/dna/svalue medical/dna/wholeNuclearDNA medical/dna/wvalue parameterisations/gflash/gflasha parallel/TopC/ParN02 parallel/TopC/ParN04; do
|
||||
generate ${DIR} ${BACK_PATH3}
|
||||
done
|
||||
|
||||
|
||||
Reference in New Issue
Block a user