Files
geant4/examples/.doxygen
2019-12-06 15:12:28 +01:00
..
2017-07-27 11:11:26 +02:00
2019-12-06 15:12:28 +01:00
2016-06-10 14:11:04 +02:00
2018-12-07 15:15:39 +01:00
2016-06-10 11:51:14 +02:00
2016-06-10 11:51:14 +02:00
2019-12-06 15:12:28 +01:00
2018-12-07 15:15:39 +01:00

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