Enhanced doxygen documentation
authorjthaeder <jthaeder@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 10 Oct 2008 08:46:33 +0000 (08:46 +0000)
committerjthaeder <jthaeder@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 10 Oct 2008 08:46:33 +0000 (08:46 +0000)
HLT/BASE/AliHLTComponent.h
HLT/BASE/AliHLTSystem.h
HLT/README
HLT/SampleLib/tutorial.c
HLT/configure.ac
HLT/doc/mainpage.c
HLT/rec/AliHLTReconstructor.h
HLT/sim/AliHLTAgentSim.h
HLT/sim/AliHLTOUTComponent.h
HLT/sim/AliHLTSimulation.h

index cecfa5d..636528c 100644 (file)
@@ -26,7 +26,7 @@
  * analysis publish new data for the subsequent components. Only the
  * input data blocks and entries from CDB are available for the analysis. 
  *
- * @section alihlt_component_intro Component implementation
+ * @section alihlt_component_implementation Component implementation
  * AliHLTComponent provides the interface for all components, see there
  * for details. Three types are provided:
  * - AliHLTProcessor
index e448151..5feeae6 100644 (file)
 /**
  * @defgroup alihlt_system HLT integration into AliRoot
  * This section describes the HLT integration into AliRoot.
+ * 
+ * @section alihlt_system_intro General Remarks
+ * The HLT analysis is organized in components which can also be used 
+ * in off-line processing. Two different types of off-line applications 
+ * can be distinguished:
+ * - AliRoot simulation (AliSimulation)
+ * - AliRoot reconstruction (AliReconstruction)
+ *
+ * The foundation of the off-line applications is a HLT chain described 
+ * by the means of AliHLTConfiguration. Special components exist, which 
+ * emulate the behavoir of the components of the HLT on-line data 
+ * transportation framework. Together with the analysis components, this 
+ * allows the full emulation of the behavoir of HLT analysis chain off-line.
+ *
+ * More details how to setup up such a chain can be found:
+ * - The examples page under @ref tut_hltsystem
+ *
+ * @section alihlt_system_simulation AliRoot simulation
+ * HLT has a special role in the normal data flow  of simulation and
+ * reconstruction. Since the HLT reconstruction and analysis runs on-line
+ * on the HLT farm, the raw data produced by HLT as a detector contains
+ * already reconstructed events. Consequently, the HLT response has to be
+ * simulated as well as the data of all other detectors. 
+ *
+ * Since the detector data is needed, the HLT simulation is run at the 
+ * end of AliSimulation.
+ *
+ * As a matter of fact, HLT always reconstructs data, <em><b>HLT simulation
+ * </b></em> means <em><b>HLT reconstruction embedded into AliRoot</b></em>.
+ *
+ * More Details an be found in the module: 
+ * - @ref alihlt_aliroot_simulation
+ *
+ * @section alihlt_system_reconstruction AliRoot reconstruction
+ *
+ * Like all other ALICE detectors, HLT utilizes the AliReconstruction interface
+ * to implement a plugin for the AliRoot reconstruction. The reconstructor can be
+ * used to
+ * - run HLT analysis chains in the AliRoot reconstruction <br>
+ *   This option is mainly intended for the development and debugging cycle. HLT
+ *   chains can be defined by means of AliHLTConfiguration and can be run either
+ *   stand-alone or embedded into the AliReconstruction cycle.
+ * - run the default analysis chains <br>
+ *   HLT modules can define default analysis chains to be run during AliRoot
+ *   reconstruction.
+ * - handle the HLTOUT data<br>
+ *   The HLT output stream contains multiple data blocks produced by the various
+ *   components of the HLT chain. Each block might need different and even
+ *   detector specific processing, like e.g. the processing of ESD objects or the
+ *   handling of compressed data.
+ *
+ * More Details an be found in the module: 
+ * - @ref alihlt_aliroot_reconstruction
+ *
  */
 
 #include "AliHLTLogging.h"
index 05121ed..8af0689 100644 (file)
@@ -16,13 +16,13 @@ Comments, bug reports, suggestions welcome!
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 + 1. Overview
 + 2. Requirements
-+ 3. Setting up a version retrieved from CVS
++ 3. Setting up a version retrieved from SVN
 + 4. Modifying a distributed package
 + 5. Installation
 + 6. Documentation
 + 7. Further information
 + 8. Reporting bugs/Asking for support
-+ 9. Committing to the AliRoot CVS
++ 9. Committing to the AliRoot SVN
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 1. Overview
@@ -55,7 +55,7 @@ usual way (ROOTSYS, ALICE_ROOT, library locations evtl. specified in
 LD_LIBRARY_PATH, ...). Actually, the BASE and SampleLib modules are
 not dependend on AliRoot. The TPCLib does.
 
-To set up a version retrieved from CVS, autoconf 2.57, automake 1.6
+To set up a version retrieved from SVN, autoconf 2.57, automake 1.6
 ,and libtool 1.4 or higher versions are required. Thats the versions
 which come with the Scientific Linux CERN 3. The same applies if
 you want to change the Makefiles.
@@ -63,11 +63,11 @@ you want to change the Makefiles.
 If your GNU build tools are too old, ask the maintainers for a distributed
 package.  
 
-3. Setting up a version retrieved from CVS
+3. Setting up a version retrieved from SVN
 ==========================================
 Skip this section if you have started from the tar ball.
 
-A version checked out from CVS requires a few steps to set up the Makefiles.
+A version checked out from SVN requires a few steps to set up the Makefiles.
 Go to the directory and run
 
   autoreconf -i -f
@@ -143,8 +143,9 @@ Some important options (all options are on by default):
   --disable-trd              # disable compilation the TRD library
   --disable-dimuon           # disable compilation the MUON library
   --disable-aliroot-logging  # disable logging
-  --disable-strict           # disable strict coding conventions and
-                               compilation flags
+  --disable-doc                     # disable creation of doxygen documentation
+  --disable-strict           # disable strict coding conventions and compilation flags
+
 
 All detector libraries (including sample and util lib) require AliRoot,
 compilation is disabled if no working AliRoot version was found. This can
index 451870b..ac0947e 100644 (file)
@@ -54,6 +54,7 @@ AliHLTConfiguration.
 -# @ref tut_macros 
 
 <br>
+<hr width="75%">
 <br>
 @section tut_hltsystem Running Components in the HLT System
 
@@ -145,6 +146,10 @@ directory.
 }
 </pre>
 
+<br>
+<hr width="75%">
+<br>
+
 @section tut_reconstruction AliRoot reconstruction
 The integration into the AliRoot reconstruction works via the
 @ref AliHLTReconstructor plugin. The intention is to run HLT analysis
@@ -276,6 +281,10 @@ in the folder.
 @see
 - conf-sample.C
 
+<br>
+<hr width="75%">
+<br>
+
 @section tut_simulation AliRoot simulation
 In order to simulate the behavior of HLT analysis chains and to
 include this functionality, HLT reconstruction can be embedded
@@ -309,6 +318,11 @@ Options:
 @see
   - sim-hlt-rawddl.C for example
 
+
+<br>
+<hr width="75%">
+<br>
+
 @section tut_alirawreaderhlt Replacing reconstruction input by data from the HLT
 The HLTOUT data can contain data blocks which obey exactly the raw DDL 
 format of a detector. E.g. selective readout components or loss-less
@@ -363,8 +377,10 @@ needs the following modules:
    - AliRawReaderHLT
    - rec-from-hltout.C
 
+<br>
+<hr width="75%">
+<br>
 
-<br><br><br>
 @section tut_macros Example macros
  */
 
index 8db7e2d..738aa94 100644 (file)
@@ -1020,8 +1020,11 @@ AC_ARG_ENABLE(doc,
   [AC_HELP_STRING([--disable-doc],
       [disable documentation build; monolithic build --enable-doc=mono ])],
   [],[enable_doc=modules])
+
 if test "x$DOXYGEN" = "x" ; then
    enable_doc=no.doxygen
+elif test "x$enable_doc" = "xyes" ; then
+   enable_doc=yes
 elif test ! "x$enable_doc" = "xmono" && \
      test ! "x$enable_doc" = "xmodules"  && \
      test ! "x$enable_doc" = "xno"; then
index 64201b5..d7b9f68 100644 (file)
     transportation framework which uses exactly the same executables (shared 
     libraries) for analysis components as the off-line framework.
 
-    \image html HLT-AliRoot-Integration_overview.png "Overview"
+    \image html  HLT-AliRoot-Integration_overview.png "Overview"
     \image latex HLT-AliRoot-Integration_overview.eps "Overview" width=14cm
 
     @section toc Sections
-
-    - @ref alihlt_wrapper_interface <br>
-      Description of the wrapper interface for external utilization of the module.
+    
+    @subsection toc_developer Developer Section
 
     - @ref alihlt_component <br>
       Description of the component interface and guidelines for component implementation.
-
+      
     - @ref alihlt_system <br>
-      Description of the HLT integration into AliRoot.
+      Description of the HLT integration into offline AliRoot. <br>
+      (AliRoot simulation, AliRoot reconstruction and analysis.)
 
     - @ref alihlt_tutorial <br>
       HLT examples and tutorials.
 
     - @ref readme <br>
+      For general comments and developers
+
+    @subsection toc_experts Expert Section
+
+    - @ref alihlt_wrapper_interface <br>
+      Description of the wrapper interface for external utilization of the module.
 
     @section libraries Detector/Module libraries
 
index 909b425..a814d82 100644 (file)
@@ -23,23 +23,34 @@ class AliHLTEsdManager;
 /**
  * @defgroup alihlt_aliroot_reconstruction AliRoot reconstruction.
  *
+ * @section alihlt_aliroot_reconstruction_intro General Remarks
  * Like all other ALICE detectors, HLT utilizes the AliReconstruction interface
  * to implement a plugin for the AliRoot reconstruction. The reconstructor can be
  * used to
- * - run HLT analysis chains in the AliRoot reconstruction <br>
- *   This option is mainly intended for the development and debugging cycle. HLT
- *   chains can be defined by means of AliHLTConfiguration and can be run either
- *   stand-alone or embedded into the AliReconstruction cycle.
- * - run the default analysis chains <br>
- *   HLT modules can define default analysis chains to be run during AliRoot
- *   reconstruction.
- * - handle the HLTOUT data<br>
- *   The HLT output stream contains multiple data blocks produced by the various
- *   components of the HLT chain. Each block might need different and even
- *   detector specific processing, like e.g. the processing of ESD objects or the
- *   handling of compressed data.
+ * -# run HLT analysis chains in the AliRoot reconstruction <br>
+ *    This option is mainly intended for the <em>development and debugging cycle</em>. 
+ *    HLT chains can be defined by means of AliHLTConfiguration and can be run either
+ *    stand-alone or embedded into the AliReconstruction cycle.
+ * -# run the default analysis chains <br>
+ *    HLT modules can define default analysis chains to be run during AliRoot
+ *    reconstruction.
+ * -# handle the HLTOUT data<br>
+ *    The HLT output stream contains multiple data blocks produced by the various
+ *    components of the HLT chain. Each block might need different and even
+ *    detector specific processing, like e.g. the processing of ESD objects or the
+ *    handling of compressed data.
+ *
+ * @section alihlt_aliroot_reconstruction_steering Steering
+ * The AliHLTReconstructor provides the main interface for the reconstruction. 
+ * The handling of the HLTOUT data is described in AliRawReaderHLT.
+ *
+ * @section alihlt_aliroot_reconstruction_examples Examples
+ * @subsection alihlt_aliroot_reconstruction_examples_reco Run chains
+ * - @ref tut_reconstruction
+ *
+ * @subsection alihlt_aliroot_reconstruction_examples_hltout Handle HLTOUT
+ * - @ref tut_alirawreaderhlt
  *
- * The AliHLTReconstructor provides the main interface for this group.
  * @ingroup alihlt_system
  */
 
index ae81659..f6945c8 100644 (file)
@@ -24,6 +24,7 @@
  * This is the agent for the HLTsim library.
  *
  * @ingroup alihlt_system
+ * @ingroup alihlt_aliroot_simulation
  */
 class AliHLTAgentSim : public AliHLTModuleAgent {
  public:
index 86c7078..2e296c5 100644 (file)
@@ -67,7 +67,7 @@ typedef vector<AliHLTMonitoringWriter*> AliHLTMonitoringWriterPVector;
  * chains have output data. By that means, the HLT output is added
  * to the simulation.
  *
- * @ingroup alihlt_rec
+ * @ingroup alihlt_aliroot_simulation
  */
 class AliHLTOUTComponent : public AliHLTOfflineDataSink  {
  public:
index 5c66174..1bcbe19 100644 (file)
 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
                                                                           */
 /**
- * @defgroup alihlt_simulation HLT simulation in AliRoot
+ * @defgroup alihlt_aliroot_simulation HLT simulation in AliRoot
  * This section describes the the simulation of the HLT in AliRoot.
- */
-
-#include "TObject.h"
-#include "TString.h"
-class AliRunLoader;
-class AliHLTSystem;
-class AliRawReader;
-
-/**
- * @class AliHLTSimulation
- * Plugin for HLT reconstruction embedded into <tt>AliSimulation</tt>.
  *
+ * @section alihlt_aliroot_simulation_intro General Remarks
  * HLT has a special role in the normal data flow  of simulation and
  * reconstruction. Since the HLT reconstruction and analysis runs on-line
  * on the HLT farm, the raw data produced by HLT as a detector contains
@@ -42,9 +32,40 @@ class AliRawReader;
  * As a matter of fact, HLT always reconstructs data, <em><b>HLT simulation
  * </b></em> means <em><b>HLT reconstruction embedded into AliRoot</b></em>.
  *
+ * @section alihlt_aliroot_simulation_steering Steering
  * The AliHLTSimulation class is the steering class called from AliSimulation.
  * An instance of AliHLTSystem is used to run the chains defined by the
- * available libraries or a configuration macro.
+ * available libraries or a AliHLTConfiguration configuration macro.
+ *
+ * The libraries to be loaded can be specified as an option to AliSimulation.
+ * <pre>
+ * AliSimulation sim;
+ * sim.SetRunHLT("libAliHLTSample.so");
+ * </pre>
+ * @see AliHLTSimulation for further details
+ *
+ * @section alihlt_aliroot_simulation_running Running
+ * The actual chains to be run depend on the HLT library modules which 
+ * are loaded to the system. There is a default collection of libraries 
+ * defined in AliHLTSystem::fgkHLTDefaultLibs. The default libraries are 
+ * loaded if nothing else is specified. The libraries implement \em agents 
+ * (AliHLTModuleAgent childs) describing the properties of a module.
+ *
+ * @section alihlt_aliroot_simulation_examples Examples
+ * - @ref tut_simulation 
+ *
+ * @ingroup alihlt_system
+ */
+
+#include "TObject.h"
+#include "TString.h"
+class AliRunLoader;
+class AliHLTSystem;
+class AliRawReader;
+
+/**
+ * @class AliHLTSimulation
+ * Plugin for HLT reconstruction embedded into <tt>AliSimulation</tt>.
  *
  * The libraries to be loaded can be specified as an option to AliSimulation.
  * <pre>
@@ -66,6 +87,7 @@ class AliRawReader;
  * \li chains=<i>configuration</i>                                      <br>
  *     comma separated list of configurations to be run during simulation
  *
+ *  @ingroup alihlt_aliroot_simulation
  */
 class AliHLTSimulation : public TObject {
  public: