Commit 969be2f6 authored by Edward Moyse's avatar Edward Moyse
Browse files

Move mainpage files to packagedoc, and make some tweaks to contents.

Added README.


Former-commit-id: bd08d1ddc913561948a3bc28cbb1fd136e9dfd2c
parent a0227aa4
......@@ -3,9 +3,9 @@
*/
in/**
\mainpage AthenaDBTestRec package
@page AthenaDBTestRec_page AthenaDBTestRec package
\section introductionAthenaDBTestRec Introduction
@section AthenaDBTestRec_introductionAthenaDBTestRec Introduction
The AthenaDBTestRec package provides a number of tools to help study and
evaluate the performance of the conditions database in the context of
......@@ -20,7 +20,7 @@ Athena, configured using a joboption file specifed by TestCoolRecWriter.
can be used to study the use of detector store objects under conditions
database control.
\section TestCoolRecWriter
@section AthenaDBTestRec_TestCoolRecWriter
This standalone application fills a COOL conditions database according to
a folder structure specification given in a configuration file. It is designed
......@@ -51,7 +51,7 @@ to read back.
- time0: initial timestamp, in seconds (default 0)
- timerun: time per run, in seconds (default 3600)
\section ConfigurationFile Configuration File
@section AthenaDBTestRec_ConfigurationFile Configuration File
The TestCoolRecWriter configuration file defines one or several database
folders. Each line starts with a keyword (case senstive) followed by
......@@ -122,7 +122,7 @@ POOL files are named according to the setting of the <filestem> parameter, as
the filename is simple <poolstem>.root. POOL files are created and registered
in the local PoolFileCatalog.xml in the usual way. If a file with the same
name is already present and registered in the catalogue, data is appended to it.
\section TestCoolRecRead
@section AthenaDBTestRec_TestCoolRecRead
TestCoolRecRead is an Athena algorithm for reading back data stored with
TestCoolRecWriter. The algorithm is configured using joboptions to set which
......@@ -184,7 +184,7 @@ The TestCoolRecExample job options.py file:
@include TestCoolRecExample.py
\section Reference Workloads
@section AthenaDBTestRec_Reference Workloads
An initial reference workload has been defined in the file refc1301.txt in
the config directory. This defines 50 folders each containing 32 channels
......@@ -265,7 +265,7 @@ be replaced by absolute pathnames in this case.
\section DetStoreDump
@section AthenaDBTestRec_DetStoreDump
DetStoreDump is a very simple algorithm that calls the Storegate dump method
on the detector store, at initialisation or at execute for the first event.
......@@ -277,15 +277,13 @@ The DetStoreDump_jobOptions.py file:
@include DetStoreDump_jobOptions.py
@section requirements requirements
@section AthenaDBTestRec_requirements requirements
The package requirements file:
@include requirements
@section uses Packages used
@section AthenaDBTestRec_uses Packages used
@htmlinclude used_packages.html
*/
/*
Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
/**
* @mainpage
*
* @section purpose Purpose: Test ESD / AOD readability
*
* @section requirements requirements
*
* @include requirements
*
* @section Links Links to used packages
*
* @htmlinclude used_packages.html
*
*/
/*
Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
/**
@page AthenaPoolDataModelTest_page @mainpage
*
@section AthenaPoolDataModelTest_@section purpose Purpose: Test ESD / AOD readability
*
@section AthenaPoolDataModelTest_@section requirements requirements
*
*
@section AthenaPoolDataModelTest_@section Links Links to used packages
*
*
*/
......@@ -3,27 +3,27 @@
*/
/**
* @mainpage
@page AthenaPoolMultiTest_page @mainpage
*
* @date 26 May 2009 J. Cranshaw
*
* @section Purpose Purpose: TEST
@section AthenaPoolMultiTest_@section Purpose Purpose: TEST
*
* AthenaPoolMultiTest is the part of the DatabaseTest packages
* that checks functionality which requires multiple files or
* multiple streams.
* <br> <br>
* @section One Dependencies and Associations
@section AthenaPoolMultiTest_@section One Dependencies and Associations
* It uses algorithms from AthenaPoolExampleAlgorithms to create
* the dummy data. The dummy data classes are defined in
* AthenaPoolExampleData and AthenaPoolTestData.
* <br><br>
* @section Two Components
@section AthenaPoolMultiTest_@section Two Components
* The algorithms defined here serve as test filters to be applied to output streams
* (EventSplit, PassAllFilter, PassNoneFilter), utilities useful for the generating test data (AddTrigMap),
* tag building (EventTagWriter, RunEventTagWriter),
* and utilities for validation (EventTagReader, EventCheck).
* @section Three Running the Tests
@section AthenaPoolMultiTest_@section Three Running the Tests
* The tests which run in the nightlies are defined in the requirements
* file using the athenarun_test pattern. They show up in the nightly
* test report under the package name. The reference files are in the
......@@ -49,12 +49,10 @@
* </ul>
* <br>
*
* @section requirements requirements
@section AthenaPoolMultiTest_@section requirements requirements
*
* @include requirements
*
* @section Links Links to used packages
@section AthenaPoolMultiTest_@section Links Links to used packages
*
* @htmlinclude used_packages.html
*
*/
......@@ -5,7 +5,7 @@
/**
@mainpage
@page AthenaPoolTest_page
AthenaPoolTest is a package containing tests of I/O for
AthenaPOOL. The tests write and read data objects which are both
......@@ -28,7 +28,7 @@ event. Different features of I/O are also tested, i.e.
- Adding of detector description tags to the EventInfo object
@section HowTheTestWork How the tests work
@section AthenaPoolTest_HowTheTestWork How the tests work
Currently the tests are run using the athenarun_test pattern. This
allows a pre and a post script to be run before/after an athena
......@@ -45,7 +45,7 @@ as specified by a selection string, which is typically the algorithm
name which appears in the output.
@section TheTests The tests
@section AthenaPoolTest_TheTests The tests
The following tests are currently being run:
......@@ -144,13 +144,11 @@ The following tests are currently being run:
.
.
@section requirements requirements
@section AthenaPoolTest_requirements requirements
@include requirements
@section uses Packages used
@section AthenaPoolTest_uses Packages used
@htmlinclude used_packages.html
*/
......@@ -4,19 +4,17 @@
/**
*
* @mainpage
@page AthenaPoolTestAthenaPool_page @mainpage
*
* @section purpose Purpose: POOL CONVERTERS
@section AthenaPoolTestAthenaPool_@section purpose Purpose: POOL CONVERTERS
*
* This package generates the pool converters for the classes
* defined in AthenaPoolTestData using the poolcnv pattern.
*
* @section requirements requirements
@section AthenaPoolTestAthenaPool_@section requirements requirements
*
* @include requirements
*
* @section Links Links to used packages
@section AthenaPoolTestAthenaPool_@section Links Links to used packages
*
* @htmlinclude used_packages.html
*
*/
......@@ -3,20 +3,18 @@
*/
/**
* @mainpage
@page AthenaPoolTestData_page @mainpage
*
* @section purpose Purpose: DATA DEFINITION
@section AthenaPoolTestData_@section purpose Purpose: DATA DEFINITION
*
* This package contains the classes used by the other test packages
* for the stored data. Dictionaries are then built using the lcgdict
* pattern.
*
* @section requirements requirements
@section AthenaPoolTestData_@section requirements requirements
*
* @include requirements
*
* @section Links Links to used packages
@section AthenaPoolTestData_@section Links Links to used packages
*
* @htmlinclude used_packages.html
*
*/
......@@ -3,9 +3,9 @@
*/
/**
\mainpage CoraCoolTest package
@page CoraCoolTest_page CoraCoolTest package
\section introductionCoraCoolTest Introduction
@section CoraCoolTest_introductionCoraCoolTest Introduction
The CoraCoolTest package provides various examples and test codes for the
CoraCool database API (found in the Database/CoraCool package) that provides
......@@ -13,7 +13,7 @@ an interface for storing conditions DB data in COOL but with the payload in
a separate table managed directly by CORAL. At present, this package only
includes the CoraCoolExample program.
\section CoraCoolExample
@section CoraCoolTest_CoraCoolExample
The CoraCoolExample class provides a standalone executable command
CoraCoolExample.exe, which exercises the storing and retrieving of data through the CoraCool API. This functions both as a simple test of the API,
......@@ -51,12 +51,10 @@ types (signed and unsigned ints and long longs, floats and doubles), plus
optionally a Coral BLOB. Created objects include information on the channel and IOV they were created for, so data read back from the database can be
checked for consistency.
@section requirements requirements
@section CoraCoolTest_requirements requirements
@include requirements
@section uses Packages used
@section CoraCoolTest_uses Packages used
@htmlinclude used_packages.html
*/
......@@ -5,7 +5,7 @@
/**
@mainpage
@page RDBAccessTest_page
RDBAccessTest is a simple test demonstrating the usage of RDBAccessSvc.
At the initialization phase the algorithm is connecting to the database
......@@ -24,7 +24,5 @@ and the field values are printed out.
REQUIREMENTS
--------------------------------
@include requirements
@htmlinclude used_packages.html
*/
......@@ -4,7 +4,7 @@
/**
@mainpage
@page TagCollectionTest_page
TagCollectionTest provides some simple tests of the POOL Collection
integration with the ATLAS Athena framework. It also contains a
......@@ -15,12 +15,12 @@ handled by the utility include ROOT and MySQL. This package was originally
implemented as part of an ATLAS offline database test suite used in the
Data Challenge 2 exercises.
@section Tests Tests
@section TagCollectionTest_Tests Tests
The table in coverage.html gives a summary of the test coverage for the Root Collection
building using the RegistrationStream.
@section Components Components
@section TagCollectionTest_Components Components
The package includes 3 classes called EventTagWriter, EventTagReader,
RunEventTagWriter each of which inherits from the Gaudi Algorithm class.
......@@ -47,7 +47,7 @@ and/or event number. The collections can be of type ROOT or MySQL.
See the following section for further details on usage. Regression tests of
this utility are included in the nightly build and are described below.
@section JobOptions Job Options
@section TagCollectionTest_JobOptions Job Options
The tests in TagCollectionTest are run via the following set of Athena Python
job options files:
......@@ -184,14 +184,14 @@ read back the respective collections created by the first 3 job options files.
@include test_ReadSimpleMySQLCollection.py
@include test_ReadSimpleMySQLltCollection.py
@section SourceCode Source Code
@section TagCollectionTest_SourceCode Source Code
TagCollectionTest resides in the package AtlasTest/DatabaseTest and can be
browsed in the ATLAS CVS repository via, for instance, the following URL:
http://atlassw1.phy.bnl.gov/lxr/source/atlas/AtlasTest/DatabaseTest/TagCollectionTest
@section RegressionTests Regression Tests
@section TagCollectionTest_RegressionTests Regression Tests
The test directory of the TagCollectionTest package contains the necessary
script, reference and pattern files to perform regression tests on the
......@@ -205,7 +205,7 @@ found in the package AtlasTest/TestTools:
http://atlassw1.phy.bnl.gov/lxr/source/atlas/AtlasTest/TestTools/scripts/nightlies/
@section ExtraPages Extra Pages
@section TagCollectionTest_ExtraPages Extra Pages
- @ref UsedPackagesTagCollectionTest
- @ref RequirementsTagCollectionTest
......@@ -213,11 +213,9 @@ http://atlassw1.phy.bnl.gov/lxr/source/atlas/AtlasTest/TestTools/scripts/nightli
/**
@page UsedPackagesTagCollectionTest Used Packages
@htmlinclude used_packages.html
*/
/**
@page RequirementsTagCollectionTest Requirements
@include requirements
*/
......@@ -4,11 +4,11 @@
/**
\mainpage
@page TestTools_page
This package contains a few tools to help writing unit tests.
\section UnitTest_run The UnitTest_run cmt pattern
@section TestTools_UnitTest_run The UnitTest_run cmt pattern
TestTools requirements file defines the cmt pattern UnitTest_run. UnitTest_run
will compile, link and run a standalone C++ program when a "gmake check"
......@@ -40,7 +40,7 @@ reported by ChronoStatSvc or the package versions and even in certain cases
pointer addresses). This is currently done in a very naive fashion (using
diff -I option) but a more sophisticated "diff" script is in the plans
\section initGaudi The initGaudi functions
@section TestTools_initGaudi The initGaudi functions
TestTools/initGaudi.h defines two functions in the namespace Athena_test
to initialize Gaudi ApplicationMgr
and be able to run using core Gaudi services. An optional string argument
......@@ -48,7 +48,7 @@ and be able to run using core Gaudi services. An optional string argument
$PKGROOT/share/<jobOptsFile>
to configure your job
\section scripts Scripts
@section TestTools_scripts Scripts
- share/runUnitTests.sh is a sh script that cmt broadcasts gmake check
and filter its output. It is
installed in the run area. It accepts one or more arguments that it passes
......@@ -59,7 +59,7 @@ to cmt broadcast, for example
- share/post.sh is a script used by the UnitTest_run pattern to
analize a job output
\section toys Toys
@section TestTools_toys Toys
The TestTools component library provides toy implementations of a number of
typical Gaudi classes, namely ToyConverter, ToyConversionSvc (and soon
......@@ -68,7 +68,7 @@ ToyAlgorithm). These are made available via the job opts file
\section Examples Examples
@section TestTools_Examples Examples
The package AthenaTests/ControlTests contains several examples that use
the initGaudi function.
......@@ -78,7 +78,7 @@ that show
- how to link the test program with an extra library (e.g. Clear_Store)
- how to use the ToyConversionSvc provided by TestTools (ProxyProviderSvc)
\section links More info
@section TestTools_links More info
The package can be browsed using LXR
(http://atlassw1.phy.bnl.gov/lxr/source/atlas/AtlasTest/TestTools/)
......
......@@ -4,7 +4,7 @@
/**
@mainpage CaloCalibHitRec Package
@page CaloCalibHitRec_page CaloCalibHitRec Package
This package provides algorithms to have LAr/Tile calorimeter calibration hits in CBNTAA.
Also it contains classes for accessing to geometry information of the dead material calibration hits.
......
......@@ -4,7 +4,7 @@
/**
@mainpage CaloClusterCorrection Package
@page CaloClusterCorrection_page CaloClusterCorrection Package
This package provides tools for calorimeter cluster corrections
......@@ -15,13 +15,13 @@ The tools are specific for sliding window clusters and Topological clusters
@author Scott Snyder <snyder@bnl.gov>
@section BaseClass ----Base classes
@section CaloClusterCorrection_BaseClass ----Base classes
CaloClusterCorrectionCommon
CaloClusterCorrection
@section ConcreteTools ----Concrete implementation
@section CaloClusterCorrection_ConcreteTools ----Concrete implementation
CaloClusterLocalCalibCone
......
......@@ -4,7 +4,7 @@
/**
@mainpage CaloAthenaPool Package
@page CaloAthenaPool_page CaloAthenaPool Package
This package provides POOL persistency event data classes.
......@@ -17,16 +17,16 @@ Calorimeter/CaloCnv/CaloTPCnv package.
@author Walter Lampl <walter.lampl@cern.ch>
@author RD Schaffer <R.D.Schaffer@cern.ch>
@section CaloCell ---- CaloCell persistency
@section CaloAthenaPool_CaloCell ---- CaloCell persistency
The persistent CaloCell is CaloCompactCell in CaloEvent. The compatification is defined by CaloCompactCellTool in CaloTools package, and used by the POOL converter.
@section CaloCluster ---- CaloCluster persistency
@section CaloAthenaPool_CaloCluster ---- CaloCluster persistency
CaloCluster consists of Links to CaloCell and CaloShower (objects in event store) and two split stores, CaloClusterMement and CaloSamplingData (contained within CaloCluster). Each of these has persistent data structure.
@section CaloTower ---- CaloTower persistency
@section CaloAthenaPool_CaloTower ---- CaloTower persistency
CaloTowerContainer contains the towers and the tower segmentation. Only the Tower segmentation has the persistent form, the towers are recreated from cells on the fly using tower builder tools. This means CaloCellContainer has to be present in the event data store, if CaloTowerContainer is needed.
@section Converters ---- POOL Converters
@section CaloAthenaPool_Converters ---- POOL Converters
CaloCellContainerCnv
......
......@@ -5,7 +5,7 @@
/**
@mainpage
@page CaloDetMgrDetDescrCnv_page
The package includes converters for the following managers: CaloDetDescrManager, CaloTTDescrManager.
......@@ -23,7 +23,5 @@ or accessed from the detector store.
REQUIREMENTS
--------------------------------
@include requirements
@htmlinclude used_packages.html
*/
......@@ -4,7 +4,7 @@
/**
@mainpage
@page CaloIdCnv_page
The CaloIdCnv package contains the converters which are necessary
to initialize the Calorimeter helpers and identifier managers. <br>
......@@ -15,8 +15,6 @@ TileTBID helper is a bit special - it is not used for normal calorimeter cells,
but used for MBTS cells in full ATLAS reconstruction as
well as for ancillary detectors at the testbeam (like Muon Wall or beam chambers)
@htmlinclude used_packages.html
@include requirements
*/
......@@ -4,9 +4,9 @@
/**
@mainpage
@page CaloJiveXML_page
@author Nikos.Konstantinidis -at- cern.ch, Eric.Jansen -at- hef.ru.nl, Juergen.Thomas -at- cern.ch
@section IntroCaloJiveXML Introduction
@section CaloJiveXML_IntroCaloJiveXML Introduction
This package contains the AlgToos that produce the XML fragments of Calorimeter related datatypes for the XML files read by atlantis.
The AlgTools, all inheriting from JiveXML::DataRetriever, are the following:
......@@ -19,8 +19,6 @@ The AlgTools, all inheriting from JiveXML::DataRetriever, are the following:
- JiveXML::CaloTBRetriever : largely obsolete now, it was used for CTB-2004 data, to access the information about the rotation of the calorimeters in the CTB setup.
@htmlinclude used_packages.html
@include requirements
*/
......@@ -4,7 +4,7 @@
/**
@mainpage CaloTPCnv Package
@page CaloTPCnv_page CaloTPCnv Package
This package provides POOL persistent representation for Calo event data classes and the T/P converters.
......@@ -14,10 +14,10 @@ Calo event data classes are T/P separated, and the POOL Converters are in Calori
@author RD Schaffer <R.D.Schaffer@cern.ch>
@section CaloCell ---- CaloCell persistency
@section CaloTPCnv_CaloCell ---- CaloCell persistency
The persistent CaloCellContainer is CaloCompactCellContainer in CaloEvent. The compatification is defined by CaloCompactCellTool in CaloTools package, and used by the POOL converter. No persistent data or tool defined here for CaloCell in this package.
@section CaloCluster ---- CaloCluster persistency
@section CaloTPCnv_CaloCluster ---- CaloCluster persistency
CaloCluster consists of Links to CaloCell and CaloShower (objects in event store) and two split stores, CaloClusterMement and CaloSamplingData (contained within CaloCluster). Each of these has persistent data structure:
CaloCellLinkContainer_p2
......@@ -30,12 +30,12 @@ CaloSamplingDataContainer_p1 and CaloSamplingData_p1
CaloShowerContainer_p2
@section CaloTower ---- CaloTower persistency
@section CaloTPCnv_CaloTower ---- CaloTower persistency
CaloTowerContainer contains the towers and the tower segmentation. Only the Tower segmentation has the persistent form, the towers are recreated from cells on the fly using tower builder tools. This means CaloCellContainer has to be present in the event data store, if CaloTowerContainer is needed.
CaloTowerContainer_p1 and CaloTowerSeg_p1
@section Converters ---- T/P converter classes
@section CaloTPCnv_Converters ---- T/P converter classes
CaloCellLinkContainerCnv_p2
......
......@@ -5,7 +5,7 @@
/**
@mainpage
@page CaloDetDescr_page
The main purpose of the CaloDetDescr package is to provide an unified
interface to readout geometry description of the ATLAS Calorimeters -
......@@ -31,7 +31,5 @@ alignment information retrieved from the Conditions Database
REQUIREMENTS
--------------------------------
@include requirements
@htmlinclude used_packages.html
*/
......@@ -4,7 +4,7 @@
/**
@mainpage CaloDmDescrt Package
@page CaloDmDetDescr_page CaloDmDescrt Package
This package contains the helper class for the Calo Dead material identifier
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment