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 1fc0ab7..33b1ec0 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 d304bff..f1d01a3 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 980fa52..33388c7 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 bd2052f..de0a7a8 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 6ad0149..9896330 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 55938cb..d6fdf6b 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 a2e840d..8525790 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 f95244d..8abdf85 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 271b2d6..c63efcd 100644 (file)
@@ -2,7 +2,7 @@
 
 /*! 
 
-\page README_geometry Geometry
+\page README_geometry MUON Geometry
 
 
 \section geometry_s1 General Information about MUON Geometry
index df881df..2ea603b 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 56efbb1..dbe47c0 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 9228290..9fce65f 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 4810b7d..1a70cca 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 ed5aa5c..de7c707 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 9379090..d9b1798 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 8bd1b89..04a1d98 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 6144300..c3cfdb9 100644 (file)
@@ -1,6 +1,6 @@
 // $Id$
 
-/*! \page README_sim Simulation 
+/*! \page README_sim MUON Simulation
 
 The simulation encompasses the following tasks :
 
index 4de1b68..88741ca 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