]> git.uio.no Git - u/mrichter/AliRoot.git/commitdiff
Updated Doxygen documentation:
authorihrivnac <ivana.hrivnacova@cern.ch>
Thu, 12 Feb 2015 14:19:56 +0000 (15:19 +0100)
committerihrivnac <ivana.hrivnacova@cern.ch>
Thu, 12 Feb 2015 14:39:38 +0000 (15:39 +0100)
- Added MUON in titles for all README pages
- Rename Doxymain.h in README.txt

18 files changed:
MUON/README.txt [moved from MUON/Doxymain.h with 92% similarity]
MUON/READMEbase.txt
MUON/READMEcalib.txt
MUON/READMEcalign.txt
MUON/READMEcosmics.txt
MUON/READMEevaluation.txt
MUON/READMEeve.txt
MUON/READMEfast.txt
MUON/READMEgeometry.txt
MUON/READMEmapping.txt
MUON/READMEmchda.txt
MUON/READMEmchview.txt
MUON/READMEmtrda.txt
MUON/READMEraw.txt
MUON/READMErec.txt
MUON/READMEshuttle.txt
MUON/READMEsim.txt
MUON/READMEtrigger.txt

similarity index 92%
rename from MUON/Doxymain.h
rename to MUON/README.txt
index 1fc0ab7b6e0f471c7b4b2e5dc75993a9ebc53933..33b1ec0215c73e42fe449540dca25b50c9cc4679 100644 (file)
@@ -1,13 +1,6 @@
-/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
- * See cxx source for full Copyright notice                               */
-
 // $Id$
 
-/// \file Doxymain.h
-/// \brief The main page for code documenation
-
-
-/*! \mainpage MUON code documentation 
+/*! \page README_MUON_main MUON code documentation 
 
 This is the documentation for the MUON simulation and reconstruction code.
 It is a mix of general concepts and code implementation details.
index d304bff5d215d00728a655b0b0f611a23ce959dc..f1d01a3fd611f9d7794efd6144bd0522a38189fb 100644 (file)
@@ -1,6 +1,6 @@
 // $Id$
 
-/*! \page README_base Data definition and access
+/*! \page README_base MUON Data definition and access
 
 Both the simulation and reconstruction use containers (called stores in the MUON jargon) 
 to hold the data we're dealing with: hits, (s)digits, trigger, clusters, tracks and 
index 980fa52b8c46eb5ddca0540bf0a14a5010a6141b..33388c7b59f7f0a48e0a84dadfe82bc7edb55b9d 100644 (file)
@@ -2,7 +2,7 @@
 
 /*! 
 
-\page README_calib Calibration
+\page README_calib MUON Calibration
  
  
 The Offline Condition DataBase is described extensively on ALICE Offline pages.
index bd2052fa89f7ed04151d3e6db1caa17bf4b06161..de0a7a8065e00cdfd314ea7d4df4e4cdf646a6d3 100644 (file)
@@ -2,7 +2,7 @@
 
 /*! 
 
-\page README_calign Offline Calibration and Alignment
+\page README_calign MUON Offline Calibration and Alignment
  
 \section calign_s1 Offline monitoring of the Alignment and Calibration
 
index 6ad0149d50342ec861f6e197244baf70236de0cd..98963307b8a839fb208edca6ecb897ea5da071e5 100644 (file)
@@ -1,6 +1,6 @@
 // $Id$
 
-/*! \page README_cosmics The Software testing on Cosmics Test Data
+/*! \page README_cosmics MUON The Software testing on Cosmics Test Data
 
 
 Seeveral macros has been developed during the Offline shifts
index 55938cba48588f5c7d9fde100309ea1e101c43ac..d6fdf6baf8ef7573a98032a473caab9856f3720c 100644 (file)
@@ -2,7 +2,7 @@
 
 /*! 
 
-\page README_evaluation Evaluation
+\page README_evaluation MUON Evaluation
  
 
 \section  evaluation_s1 How to process invariant mass spectra for J/psi or Upsilon
index a2e840d082c056598acf5d74a9a76399286334c4..852579050b6c3225d1421513c84db82a16d17c07 100644 (file)
@@ -2,7 +2,7 @@
 
 /*!
 
-\page README_eve Event display
+\page README_eve MUON Event display
 
 This README file shows how to use both the old and new EVE event display for
 the MUON detector. The explained procedure is a complement to the visualisation
index f95244dfa189837a6d84fd333d1dad3ec280e80d..8abdf85fe859ed8e009b14388fc557e3d69fa30f 100644 (file)
@@ -2,7 +2,7 @@
 
 /*! 
 
-\page README_fast Fast simulation
+\page README_fast MUON Fast simulation
 
 
 The macro fastMUONGen.C allows to generate events using the 
index 271b2d6cb3fd64219d126e86be7c1456db2f59bd..c63efcdcfb97dcfdaadfee62b8d9bfd27ec58a77 100644 (file)
@@ -2,7 +2,7 @@
 
 /*! 
 
-\page README_geometry Geometry
+\page README_geometry MUON Geometry
 
 
 \section geometry_s1 General Information about MUON Geometry
index df881df368eda396c08ec25b740aa820335c4ec8..2ea603b247f53f3ceb24f1a87556656ea6cb4c40 100644 (file)
@@ -2,7 +2,7 @@
 
 /*! 
 
-\page README_mapping Mapping
+\page README_mapping MUON Mapping
  
 
 See the detailed description of the mapping package in ALICE-INT-2003-025.
index 56efbb1486f6be910e0d0971e92996eccaf0e2f2..dbe47c0f97a4e8ef142dd595234f5a369506fee0 100644 (file)
@@ -2,7 +2,7 @@
 
 /*! 
 
-\page README_mchda Tracking DA
+\page README_mchda MUON Tracking DA
  
 The detector algorithms are implemented for the Muon Tracking in the AliRoot framework.
 We currently have 3 DAs for MCH :
index 922829052b092de5532a338c8c06e2c18eb31946..9fce65fa54bf047a34ef2d2cd9b58c65b44b1e80 100644 (file)
@@ -1,6 +1,6 @@
 // $Id$
 
-/*! \page README_mchview Tracker visualisation program
+/*! \page README_mchview MUON Tracker visualisation program
 
 A visualisation program, \link mchview.cxx mchview \endlink, is now available to display, in two dimensions
  (3D visu being done within the EVE framework), the tracker chambers. 
index 4810b7d08d8f270772b1ed6fa6447633c61aafe0..1a70ccaef8a7a607bd0bfd43658668f83cd7a796 100644 (file)
@@ -2,7 +2,7 @@
 
 /*! 
 
-\page README_mtrda Trigger DA
+\page README_mtrda MUON Trigger DA
  
 The detector algorithm is implemented for the Muon Trigger in the AliRoot 
 framework. The main code is located in MUONTRGda.cxx and it runs in the MUON 
index ed5aa5c4b1b99d08d79c89850faa73b5de93ba05..de7c7079864ac418fe518d00d9d13ae3a9c6e876 100644 (file)
@@ -2,7 +2,7 @@
 
 /*! 
 
-\page README_raw Raw data
+\page README_raw MUON Raw data
  
 \section raw_s1 How to read & decode raw data 
 
index 93790901b5a6b78900c30a405fa2971023c37c0d..d9b1798bbdb1f7a3fad0cbaa2b840e6f773050fc 100644 (file)
@@ -2,7 +2,7 @@
 
 /*! 
 
-\page README_rec Reconstruction
+\page README_rec MUON Reconstruction
  
 The reconstruction is a multistage process, driven by the AliMUONTracker and AliMUONReconstructor classes
 via the AliReconstruction class, which is divided into three parts:
index 8bd1b899daea9ad8fdda170badb80f4491df6449..04a1d982b9d73967d0c65309cfc1188a1aaf4f4c 100644 (file)
@@ -2,7 +2,7 @@
 
 /*! 
 
-\page README_shuttle Shuttle 
+\page README_shuttle MUON Shuttle
 
 How to test the Shuttle preprocessor(s) for MUON.
 
index 6144300c039e2ab003a8cd643ab67bc3d9acd42d..c3cfdb9554c7ded45d215eb0771ba792b4031336 100644 (file)
@@ -1,6 +1,6 @@
 // $Id$
 
-/*! \page README_sim Simulation 
+/*! \page README_sim MUON Simulation
 
 The simulation encompasses the following tasks :
 
index 4de1b682ce94dca24ee1983de4af762a3b257602..88741cabec145a94d0828ba080c3e1f0ef33db0c 100644 (file)
@@ -2,7 +2,7 @@
 
 /*! 
 
-\page README_trigger Trigger
+\page README_trigger MUON Trigger
 
 
 \section trigger_s1  How to reprocess trigger decision from already produced digits