From 631a1685d03cf29d05da1381efd5d69c5ace6358 Mon Sep 17 00:00:00 2001 From: ihrivnac Date: Thu, 12 Feb 2015 15:19:56 +0100 Subject: [PATCH] Updated Doxygen documentation: - Added MUON in titles for all README pages - Rename Doxymain.h in README.txt --- MUON/{Doxymain.h => README.txt} | 9 +-------- MUON/READMEbase.txt | 2 +- MUON/READMEcalib.txt | 2 +- MUON/READMEcalign.txt | 2 +- MUON/READMEcosmics.txt | 2 +- MUON/READMEevaluation.txt | 2 +- MUON/READMEeve.txt | 2 +- MUON/READMEfast.txt | 2 +- MUON/READMEgeometry.txt | 2 +- MUON/READMEmapping.txt | 2 +- MUON/READMEmchda.txt | 2 +- MUON/READMEmchview.txt | 2 +- MUON/READMEmtrda.txt | 2 +- MUON/READMEraw.txt | 2 +- MUON/READMErec.txt | 2 +- MUON/READMEshuttle.txt | 2 +- MUON/READMEsim.txt | 2 +- MUON/READMEtrigger.txt | 2 +- 18 files changed, 18 insertions(+), 25 deletions(-) rename MUON/{Doxymain.h => README.txt} (92%) diff --git a/MUON/Doxymain.h b/MUON/README.txt similarity index 92% rename from MUON/Doxymain.h rename to MUON/README.txt index 1fc0ab7b6e0..33b1ec0215c 100644 --- a/MUON/Doxymain.h +++ b/MUON/README.txt @@ -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. diff --git a/MUON/READMEbase.txt b/MUON/READMEbase.txt index d304bff5d21..f1d01a3fd61 100644 --- a/MUON/READMEbase.txt +++ b/MUON/READMEbase.txt @@ -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 diff --git a/MUON/READMEcalib.txt b/MUON/READMEcalib.txt index 980fa52b8c4..33388c7b59f 100644 --- a/MUON/READMEcalib.txt +++ b/MUON/READMEcalib.txt @@ -2,7 +2,7 @@ /*! -\page README_calib Calibration +\page README_calib MUON Calibration The Offline Condition DataBase is described extensively on ALICE Offline pages. diff --git a/MUON/READMEcalign.txt b/MUON/READMEcalign.txt index bd2052fa89f..de0a7a8065e 100644 --- a/MUON/READMEcalign.txt +++ b/MUON/READMEcalign.txt @@ -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 diff --git a/MUON/READMEcosmics.txt b/MUON/READMEcosmics.txt index 6ad0149d503..98963307b8a 100644 --- a/MUON/READMEcosmics.txt +++ b/MUON/READMEcosmics.txt @@ -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 diff --git a/MUON/READMEevaluation.txt b/MUON/READMEevaluation.txt index 55938cba485..d6fdf6baf8e 100644 --- a/MUON/READMEevaluation.txt +++ b/MUON/READMEevaluation.txt @@ -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 diff --git a/MUON/READMEeve.txt b/MUON/READMEeve.txt index a2e840d082c..852579050b6 100644 --- a/MUON/READMEeve.txt +++ b/MUON/READMEeve.txt @@ -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 diff --git a/MUON/READMEfast.txt b/MUON/READMEfast.txt index f95244dfa18..8abdf85fe85 100644 --- a/MUON/READMEfast.txt +++ b/MUON/READMEfast.txt @@ -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 diff --git a/MUON/READMEgeometry.txt b/MUON/READMEgeometry.txt index 271b2d6cb3f..c63efcdcfb9 100644 --- a/MUON/READMEgeometry.txt +++ b/MUON/READMEgeometry.txt @@ -2,7 +2,7 @@ /*! -\page README_geometry Geometry +\page README_geometry MUON Geometry \section geometry_s1 General Information about MUON Geometry diff --git a/MUON/READMEmapping.txt b/MUON/READMEmapping.txt index df881df368e..2ea603b247f 100644 --- a/MUON/READMEmapping.txt +++ b/MUON/READMEmapping.txt @@ -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. diff --git a/MUON/READMEmchda.txt b/MUON/READMEmchda.txt index 56efbb1486f..dbe47c0f97a 100644 --- a/MUON/READMEmchda.txt +++ b/MUON/READMEmchda.txt @@ -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 : diff --git a/MUON/READMEmchview.txt b/MUON/READMEmchview.txt index 922829052b0..9fce65fa54b 100644 --- a/MUON/READMEmchview.txt +++ b/MUON/READMEmchview.txt @@ -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. diff --git a/MUON/READMEmtrda.txt b/MUON/READMEmtrda.txt index 4810b7d08d8..1a70ccaef8a 100644 --- a/MUON/READMEmtrda.txt +++ b/MUON/READMEmtrda.txt @@ -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 diff --git a/MUON/READMEraw.txt b/MUON/READMEraw.txt index ed5aa5c4b1b..de7c7079864 100644 --- a/MUON/READMEraw.txt +++ b/MUON/READMEraw.txt @@ -2,7 +2,7 @@ /*! -\page README_raw Raw data +\page README_raw MUON Raw data \section raw_s1 How to read & decode raw data diff --git a/MUON/READMErec.txt b/MUON/READMErec.txt index 93790901b5a..d9b1798bbdb 100644 --- a/MUON/READMErec.txt +++ b/MUON/READMErec.txt @@ -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: diff --git a/MUON/READMEshuttle.txt b/MUON/READMEshuttle.txt index 8bd1b899dae..04a1d982b9d 100644 --- a/MUON/READMEshuttle.txt +++ b/MUON/READMEshuttle.txt @@ -2,7 +2,7 @@ /*! -\page README_shuttle Shuttle +\page README_shuttle MUON Shuttle How to test the Shuttle preprocessor(s) for MUON. diff --git a/MUON/READMEsim.txt b/MUON/READMEsim.txt index 6144300c039..c3cfdb9554c 100644 --- a/MUON/READMEsim.txt +++ b/MUON/READMEsim.txt @@ -1,6 +1,6 @@ // $Id$ -/*! \page README_sim Simulation +/*! \page README_sim MUON Simulation The simulation encompasses the following tasks : diff --git a/MUON/READMEtrigger.txt b/MUON/READMEtrigger.txt index 4de1b682ce9..88741cabec1 100644 --- a/MUON/READMEtrigger.txt +++ b/MUON/READMEtrigger.txt @@ -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 -- 2.43.0