Import Geant4 11.0.0 source tree

2021-12-12 17:16:06 +01:00
parent 80e2389dd8
commit 84f33a068c
593 changed files with 68589 additions and 1 deletions
@@ -0,0 +1,24 @@
+
+///\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.
+
+*/
@@ -0,0 +1,25 @@
+
+///\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
+
+*/
@@ -0,0 +1,25 @@
+
+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
+