Porting HLT doxygen documentation to cmake
authorTimo Breitner <timo.gunther.breitner@cern.ch>
Tue, 7 Jan 2014 10:47:21 +0000 (11:47 +0100)
committerTimo Breitner <timo.gunther.breitner@cern.ch>
Tue, 7 Jan 2014 12:39:24 +0000 (13:39 +0100)
HLT documentation can now be build with cmake. It's disabled per
default, but can be enabled via cmake option "HLT_DOC",
e.g. cmake -DHLT_DOC=ON.
It's not included in the default make target, but has to be explicitely
build via

make hltdoc
make install

Documentation will be installed in "$ALICE_INSTALL/doc/HLT/html".

Also fixed some inconsistencies in the doxygen tags in various headers.
Nevertheless there are many undocumented files (esp. TPC), has to be
revisited at some point.

53 files changed:
HLT/BASE/AliHLTDataDeflaterSimple.h
HLT/BASE/AliHLTEventStatistics.h
HLT/BASE/AliHLTHuffman.h
HLT/CALO/AliHLTCaloConstants.h
HLT/CALO/AliHLTCaloDigitMaker.cxx
HLT/CMakeLists.txt
HLT/CMakehltdoc.conf [new file with mode: 0644]
HLT/EVE/tutorial.c
HLT/ITS/AliHLTITSQAComponent.cxx
HLT/ITS/AliHLTITSQAComponent.h
HLT/MUON/AliHLTMUONLinkDef.h
HLT/MUON/AliHLTMUONProcessor.h
HLT/MUON/OfflineInterface/AliHLTMUONDigitPublisherComponent.h
HLT/MUON/OfflineInterface/AliHLTMUONESDMaker.h
HLT/MUON/OfflineInterface/AliHLTMUONRootifierComponent.h
HLT/MUON/OnlineAnalysis/AliHLTMUONClusterFinderComponent.h
HLT/MUON/OnlineAnalysis/AliHLTMUONDecisionComponent.h
HLT/MUON/OnlineAnalysis/AliHLTMUONHitReconstructorComponent.h
HLT/MUON/OnlineAnalysis/AliHLTMUONMansoTrackerFSMComponent.h
HLT/MUON/OnlineAnalysis/AliHLTMUONTriggerReconstructorComponent.h
HLT/MUON/utils/AliHLTMUONClusterHistoComponent.h
HLT/MUON/utils/AliHLTMUONDataCheckerComponent.h
HLT/MUON/utils/AliHLTMUONEmptyEventFilterComponent.h
HLT/MUON/utils/AliHLTMUONRawDataHistoComponent.h
HLT/SampleLib/tutorial.c
HLT/TPCLib/AliHLTTPCClusterHistoComponent.h
HLT/TPCLib/HWCFemulator/macro/makeConfigurationObjectTPCHWClusterFinder.C
HLT/TRD/AliHLTTRDOfflineTrackerV1Component.h
HLT/doc/doxygen.conf.in
HLT/doc/mainpage.c
HLT/doc/module_group.c [new file with mode: 0644]
HLT/global/AliHLTGlobalEsdConverterComponent.h
HLT/global/AliHLTGlobalHistoCollector.h
HLT/global/AliHLTGlobalHistoComponent.h
HLT/global/AliHLTGlobalTrackMatcher.cxx
HLT/global/docalihltglobal.c [new file with mode: 0644]
HLT/global/physics/AliHLTCaloHistoCellEnergy.cxx
HLT/global/physics/AliHLTCaloHistoCellEnergy.h
HLT/global/physics/AliHLTCaloHistoClusterEnergy.cxx
HLT/global/physics/AliHLTCaloHistoClusterEnergy.h
HLT/global/physics/AliHLTCaloHistoComponent.h
HLT/global/physics/AliHLTCaloHistoInvMass.cxx
HLT/global/physics/AliHLTCaloHistoInvMass.h
HLT/global/physics/AliHLTCaloHistoMatchedTracks.cxx
HLT/global/physics/AliHLTCaloHistoMatchedTracks.h
HLT/global/physics/AliHLTCaloHistoProducer.cxx
HLT/global/physics/AliHLTCaloHistoProducer.h
HLT/global/physics/AliHLTMultiplicityCorrelations.h
HLT/global/physics/AliHLTMultiplicityCorrelationsComponent.h
HLT/global/physics/macros/HLTMultiplicityCorrelationsTest.C
HLT/global/physics/macros/makeConfigurationObjectMultiplicityCorrelations.C
HLT/global/physics/macros/makeConfigurationObjectdNdPtAnalysis.C
HLT/trigger/menu/HM-PHYSICS-V0001.C

index 4dc4f37..6bd33fc 100644 (file)
@@ -35,7 +35,8 @@ public:
   /// destructor
   ~AliHLTDataDeflaterSimple();
 
-  /// @class AliHLTDataDeflaterParameter definition of parameters
+  /// @class AliHLTDataDeflaterParameter 
+  //  definition of parameters
   class AliHLTDataDeflaterParameter {
   public:
     AliHLTDataDeflaterParameter()
index ba6afa0..c90033c 100644 (file)
  * event and run summary handling for the HLT chain.
  */
 
-/**
- * @defgroup alihlt_trigger Trigger components for the HLT.
- * This section describes the handling of different triggers of the HLT.
- * @ingroup alihlt_modules
- */
-
 #include "TObject.h"
 #include "TString.h"
 
index b11857b..bb2c413 100644 (file)
@@ -6,7 +6,7 @@
 //* ALICE Experiment at CERN, All rights reserved.                         *
 //* See cxx source for full Copyright notice                               *
 
-/// @file   AliHLTDataHuffman.h
+/// @file   AliHLTHuffman.h
 /// @author Thorsten Kollegger, Matthias Richter
 /// @date   2011-08-14
 /// @brief  Huffman code generator/encoder/decode
index ebd91b7..3a95f66 100644 (file)
@@ -5,7 +5,7 @@
 //* ALICE Experiment at CERN, All rights reserved.                         *
 //* See cxx source for full Copyright notice                               */
 
-/// @file   AliHLCaloConstants.h
+/// @file   AliHLTCaloConstants.h
 /// @author Svein Lindal
 /// @date   
 /// @brief  Class containing constants for PHOS and EMCAL
index 7e28a94..eaa94b5 100644 (file)
@@ -15,7 +15,7 @@
  * provided "as is" without express or implied warranty.                  *\r
  **************************************************************************/\r
  /** \r
- * @file   AliHLTCALOClusterizer.cxx\r
+ * @file   AliHLTCaloDigitMaker.cxx\r
  * @author Oystein Djuvsland\r
  * @date \r
  * @brief  Digit maker for CALO HLT  \r
index 57fcbc8..8559dc6 100644 (file)
@@ -5,6 +5,8 @@
 
 cmake_minimum_required(VERSION 2.8.4 FATAL_ERROR)
 
+include("CMakehltdoc.conf")
+
 file(GLOB PACKAGES CMake*.pkg)
 
 ALICE_BuildModule()
diff --git a/HLT/CMakehltdoc.conf b/HLT/CMakehltdoc.conf
new file mode 100644 (file)
index 0000000..7ac39dd
--- /dev/null
@@ -0,0 +1,63 @@
+# -*- mode: cmake -*-
+# $Id$
+
+
+option(HLT_DOC "Create and install the HLT API documentation (requires Doxygen)" OFF)
+
+IF(HLT_DOC)
+  FIND_PACKAGE(Doxygen)
+  IF(NOT DOXYGEN_FOUND)
+    MESSAGE(FATAL_ERROR
+      "Doxygen is needed to build the documentation.")
+  ENDIF()
+
+  SET(HLT_doxy_depend doc/mainpage.c)
+  SET(HLT_doxy_input)
+  SET(HLT_doxy_source_paths 
+    doc
+    BASE
+    SampleLib
+    rec
+    exa
+    shuttle
+    sim
+    global
+    trigger
+    TPCLib
+    MUON
+    )
+
+  SET(HLT_doxy_source_exclude_paths ${CMAKE_CURRENT_SOURCE_DIR}/TPCLib/tracking-ca/cagpu)
+
+  FOREACH(mypath ${HLT_doxy_source_paths})
+    SET(HLT_doxy_input "${HLT_doxy_input} ${CMAKE_CURRENT_SOURCE_DIR}/${mypath}")
+    FILE(GLOB_RECURSE tmpvar ${mypath}/*.[h,c,cxx,C])
+    SET(HLT_doxy_depend ${HLT_doxy_depend} ${tmpvar})
+  ENDFOREACH(mypath ${HLT_doxy_source_paths})
+
+  SET( HLT_doxyfile_in          ${CMAKE_CURRENT_SOURCE_DIR}/doc/doxygen.conf.in )
+  SET( HLT_doxy_image_path      ${CMAKE_CURRENT_SOURCE_DIR}/doc/pics            ) 
+  SET( HLT_doxyfile             ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile            )
+  SET( HLT_doxy_html_index_file ${CMAKE_CURRENT_BINARY_DIR}/html/index.html     )
+  SET( HLT_doxy_output_root     ${CMAKE_CURRENT_BINARY_DIR}                     )
+  CONFIGURE_FILE( ${HLT_doxyfile_in} ${HLT_doxyfile} @ONLY )
+  ADD_CUSTOM_COMMAND( OUTPUT ${HLT_doxy_html_index_file}
+    COMMAND ${DOXYGEN_EXECUTABLE} ${HLT_doxyfile}
+    # The following should be ${doxyfile} only but it
+    # will break the dependency.
+    # The optimal solution would be creating a 
+    # custom_command for ${doxyfile} generation
+    # but I still have to figure out how...
+    MAIN_DEPENDENCY ${HLT_doxyfile} ${HLT_doxyfile_in}
+    DEPENDS ${HLT_doxy_depend}
+    COMMENT "Generating HLT HTML documentation")
+  
+  ADD_CUSTOM_TARGET( hltdoc DEPENDS ${HLT_doxy_html_index_file} )
+
+  #Have to create html dir, otherwise install fails if doc hasn't been build
+  FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html)
+
+  INSTALL( DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION doc/HLT )
+ENDIF(HLT_DOC)
index 10a11aa..48368bc 100644 (file)
@@ -19,7 +19,7 @@
 **
 *************************************************************************/
 
-/** @file   tutorial.c
+/** @file   EVE/tutorial.c
     @author Matthias Richter
     @date   
     @brief  HLT examples and tutorial. */
index d877f57..2bac152 100644 (file)
@@ -15,7 +15,7 @@
 //* provided "as is" without express or implied warranty.                  *
 //**************************************************************************
 
-/// @file   AliHLTITSQHistoComponent.cxx
+/// @file   AliHLTITSQAComponent.cxx
 /// @author Piergiorgio Cerello cerello@to.infn.it
 /// @date   2009-07-03
 /// @brief  Interface component to the ITS QA
index d0e0c6a..7cd9c8d 100644 (file)
@@ -6,7 +6,7 @@
 //* ALICE Experiment at CERN, All rights reserved.                         *
 //* See cxx source for full Copyright notice                               *
 
-/// @file   AliHLTITSQHistoComponent.h
+/// @file   AliHLTITSQAComponent.h
 /// @author Piergiorgio Cerello cerello@to.infn.it
 /// @date   2009-07-03
 /// @brief  Interface component to the ITS QA
index 63607c6..330df60 100644 (file)
@@ -17,7 +17,7 @@
 // $Id$
 
 ///
-/// @file   HLTMUONLinkDef.h
+/// @file   AliHLTMUONLinkDef.h
 /// @author Artur Szostak <artursz@iafrica.com>
 /// @date   29 May 2007
 /// @brief  Linkdef file for dHLT.
index aebf58e..36960fc 100644 (file)
@@ -47,7 +47,7 @@ class AliMUONRecoParam;
  *      Allows one to specify the path in which to dump the received data blocks
  *      if an error occurs. <br>
  *
- * @ingroup alihlt_dimuon_component
+ * @ingroup alihlt_muon_components
  */
 class AliHLTMUONProcessor : public AliHLTProcessor
 {
index 59db0f2..4b18d7f 100644 (file)
@@ -72,7 +72,7 @@ class AliMUONDataInterface;
  *      the generated raw DDL stream. The detector element ID numbers <number> should
  *      be in the range [100..1099]. <br>
  *
- * @ingroup alihlt_dimuon_component
+ * @ingroup alihlt_muon_components
  */
 class AliHLTMUONDigitPublisherComponent : public AliHLTOfflineDataSource
 {
index 6df4f64..abb9d03 100644 (file)
@@ -58,7 +58,7 @@ class AliESDEvent;
  *      Allows one to specify the path in which to dump the received data blocks
  *      if an error occurs. <br>
  *
- * @ingroup alihlt_dimuon_component
+ * @ingroup alihlt_muon_components
  */
 class AliHLTMUONESDMaker : public AliHLTMUONProcessor
 {
index 2719458..18aa3bb 100644 (file)
@@ -66,7 +66,7 @@ extern "C" struct AliHLTMUONMansoTrackStruct;
  * <h2>Output size:</h2>
  * A few kBytes.
  *
- * @ingroup alihlt_dimuon_component
+ * @ingroup alihlt_muon_components
  */
 class AliHLTMUONRootifierComponent : public AliHLTMUONProcessor
 {
index c077ec9..32ea091 100644 (file)
@@ -92,7 +92,7 @@ class AliMUONRecoParam;
  * <h2>Output size:</h2>
  * Output size is about 25% of incoming raw input data for nominal p+p events.
  *
- * @ingroup alihlt_dimuon_component
+ * @ingroup alihlt_muon_components
  */
 class AliHLTMUONClusterFinderComponent : public AliHLTMUONProcessor
 {
index f834ba4..fd270cd 100644 (file)
@@ -124,7 +124,7 @@ extern "C" struct AliHLTMUONPairsDecisionBlockStruct;
  * This will depend linearly on the number of tracks found. But for nominal
  * multiplicities this should be less than 16 kBytes.
  *
- * @ingroup alihlt_dimuon_component
+ * @ingroup alihlt_muon_components
  */
 class AliHLTMUONDecisionComponent : public AliHLTMUONProcessor
 {
index ae53f37..9d41a93 100644 (file)
@@ -144,7 +144,7 @@ extern "C" struct AliHLTMUONHitRecoLutRow;
  * <h2>Output size:</h2>
  * Output size is about 10% of incoming raw input data for nominal p+p events.
  *
- * @ingroup alihlt_dimuon_component
+ * @ingroup alihlt_muon_components
  */
 class AliHLTMUONHitReconstructorComponent : public AliHLTMUONProcessor
 {
index 3aeb2ed..d0d66d6 100644 (file)
@@ -158,7 +158,7 @@ struct AliHLTMUONRecHitStruct;
  * Output size is about equivalent to the incoming reconstructed hit and trigger
  * record input data.
  *
- * @ingroup alihlt_dimuon_component
+ * @ingroup alihlt_muon_components
  */
 class AliHLTMUONMansoTrackerFSMComponent
        : public AliHLTMUONProcessor, public AliHLTMUONMansoTrackerFSMCallback
index 6731cbe..0f759c3 100644 (file)
@@ -150,7 +150,7 @@ class AliHLTMUONTriggerReconstructor;
  * This will depend linearly on the number of tracks found. But for nominal multiplicities
  * this should be less than 16 kBytes.
  *
- * @ingroup alihlt_dimuon_component
+ * @ingroup alihlt_muon_components
  */
 class AliHLTMUONTriggerReconstructorComponent : public AliHLTMUONProcessor
 {
index dfd6b04..930294d 100644 (file)
@@ -25,7 +25,7 @@
  * Optional arguments: <br>
  * 
  *
- * @ingroup alihlt_dimuon_components
+ * @ingroup alihlt_muon_components
  */
 
 class AliHLTMUONClusterHistoComponent : public AliHLTMUONProcessor
index ed00ca0..f5ba585 100644 (file)
@@ -85,7 +85,7 @@ extern "C" struct AliHLTMUONTrackStruct;
  *      Allows one to specify the path in which to dump the received data blocks
  *      if an error occurs. <br>
  *
- * @ingroup alihlt_dimuon_component
+ * @ingroup alihlt_muon_components
  */
 class AliHLTMUONDataCheckerComponent : public AliHLTMUONProcessor
 {
index 6267ad0..66bc7b6 100644 (file)
@@ -75,7 +75,7 @@
  * <h2>Output size:</h2>
  * The maximum is the same size as the input data size.
  *
- * @ingroup alihlt_dimuon_component
+ * @ingroup alihlt_muon_components
  */
 class AliHLTMUONEmptyEventFilterComponent : public AliHLTMUONProcessor
 {
index 1364b4f..0f7f57d 100644 (file)
@@ -74,7 +74,7 @@
  * <h2>Output size:</h2>
  * A few kBytes.
  *
- * @ingroup alihlt_dimuon_component
+ * @ingroup alihlt_muon_components
  */
 class AliHLTMUONRawDataHistoComponent : public AliHLTMUONProcessor
 {
index 10a11aa..3173f45 100644 (file)
@@ -19,7 +19,7 @@
 **
 *************************************************************************/
 
-/** @file   tutorial.c
+/** @file   SampleLib/tutorial.c
     @author Matthias Richter
     @date   
     @brief  HLT examples and tutorial. */
index 9c3e94e..e80ba28 100644 (file)
@@ -6,7 +6,7 @@
 //* ALICE Experiment at CERN, All rights reserved.                         *
 //* See cxx source for full Copyright notice                               *
 
-/// @file   AliHLTTPCQHistoComponent.h
+/// @file   AliHLTTPCClusterHistoComponent.h
 /// @author Gaute Ovrebekk
 /// @brief  Component for ploting charge in clusters
 ///
@@ -16,7 +16,7 @@
 #include "AliHLTTPCSpacePointData.h"
 
 /**
- * @class AliHLTTPCQHistoComponent
+ * @class AliHLTTPCClusterHistoComponent
  * Component for ploting charge in clusters
  * 
  * Component ID: \b TPCQHisto <br>
index 7bbba2d..6a56d1b 100644 (file)
@@ -20,7 +20,7 @@
  *  - ""  <pre> aliroot -b -q makeConfigurationObjectTPCHWClusterFinder.C </pre>
  *
  * @author Sergey Gorbunov <sergey.gorbunov@fias.uni-frankfurt.de>
- * @ingroup alihlt_physics
+ * @ingroup alihlt_tpc
  */
 void makeConfigurationObjectTPCHWClusterFinder(const Char_t* param="", const Char_t* cdbUri=NULL,
                                      Int_t runMin=0, Int_t runMax=AliCDBRunRange::Infinity()) {
index 8b0c833..823b615 100644 (file)
@@ -6,7 +6,7 @@
 //* ALICE Experiment at CERN, All rights reserved.                         *
 //* See cxx source for full Copyright notice                               *
 
-/** @file   AliHLTTRDOfflineTrackerV1Component
+/** @file   AliHLTTRDOfflineTrackerV1Component.cxx
     @author 
     @date   2009-08-31
     @brief  
index 5318e14..fc256b2 100644 (file)
@@ -11,9 +11,9 @@
 # http://www.gnu.org/software/libiconv for the list of possible encodings.
 
 DOXYFILE_ENCODING      = UTF-8
-PROJECT_NAME           = "@PACKAGE_NAME@"
-PROJECT_NUMBER         = @PACKAGE_VERSION@
-OUTPUT_DIRECTORY       = .
+PROJECT_NAME           = "ALICE HLT"
+PROJECT_NUMBER         = @ALIROOT_BRANCH@
+OUTPUT_DIRECTORY       = @HLT_doxy_output_root@
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
 BRIEF_MEMBER_DESC      = NO
@@ -76,7 +76,7 @@ GENERATE_DEPRECATEDLIST= YES
 ENABLED_SECTIONS       = 
 MAX_INITIALIZER_LINES  = 30
 SHOW_USED_FILES        = YES
-SHOW_DIRECTORIES       = NO
+#SHOW_DIRECTORIES       = NO
 SHOW_FILES             = YES
 SHOW_NAMESPACES        = YES
 FILE_VERSION_FILTER    = 
@@ -94,21 +94,13 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = @top_srcdir@/doc      \
-                        readme.c               \
-                        sample_readme.c        \
-                        module_group.c         \
-                        @top_srcdir@/BASE      \
-                        @top_srcdir@/SampleLib \
-                        @top_srcdir@/rec       \
-                        @top_srcdir@/exa       \
-                        @top_srcdir@/shuttle   \
-                        @top_srcdir@/sim
+INPUT                  = @HLT_doxy_input@
+
 INPUT_ENCODING         = UTF-8
 
-FILE_PATTERNS          = *.h *.c *.cpp *.hpp *.cxx *.C
+FILE_PATTERNS          = *.h *.c *.cpp *.hpp *.cxx
 RECURSIVE              = YES
-EXCLUDE                = @top_srcdir@/TPCLib/gui
+EXCLUDE                = @HLT_doxy_source_exclude_paths@
 
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       = 
@@ -116,7 +108,7 @@ EXCLUDE_SYMBOLS        =
 EXAMPLE_PATH           = 
 EXAMPLE_PATTERNS       = 
 EXAMPLE_RECURSIVE      = NO
-IMAGE_PATH             = @srcdir@/pics
+IMAGE_PATH             = @HLT_doxy_image_path@
 INPUT_FILTER           = 
 FILTER_PATTERNS        = 
 FILTER_SOURCE_FILES    = NO
@@ -146,7 +138,7 @@ HTML_FILE_EXTENSION    = .html
 HTML_HEADER            = 
 HTML_FOOTER            = 
 HTML_STYLESHEET        = 
-HTML_ALIGN_MEMBERS     = YES
+#HTML_ALIGN_MEMBERS     = YES
 HTML_DYNAMIC_SECTIONS  = NO
 GENERATE_DOCSET        = NO
 DOCSET_FEEDNAME        = 
@@ -226,38 +218,40 @@ EXPAND_ONLY_PREDEF     = NO
 SEARCH_INCLUDES        = YES
 INCLUDE_PATH           = 
 INCLUDE_FILE_PATTERNS  = 
-PREDEFINED             = "DOXYGEN_INPUT" 
+PREDEFINED             = ClassImp()= \
+                      GPUd()=
 EXPAND_AS_DEFINED      = 
 SKIP_FUNCTION_MACROS   = YES
 #---------------------------------------------------------------------------
 # Configuration::addtions related to external references   
 #---------------------------------------------------------------------------
 TAGFILES               = 
-GENERATE_TAGFILE       = @PACKAGE@.tags
+GENERATE_TAGFILE       = 
 ALLEXTERNALS           = NO
 EXTERNAL_GROUPS        = YES
-PERL_PATH              = @PERL@
+PERL_PATH              = 
 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool   
 #---------------------------------------------------------------------------
 CLASS_DIAGRAMS         = YES
 HIDE_UNDOC_RELATIONS   = NO
-HAVE_DOT               = @HAVE_DOT@
-DOT_FONTNAME           = FreeSans
+HAVE_DOT               = @DOXYGEN_DOT_FOUND@
+DOT_FONTNAME           = Sans
 DOT_FONTSIZE           = 10
 CLASS_GRAPH            = YES
-COLLABORATION_GRAPH    = YES
+COLLABORATION_GRAPH    = NO
 GROUP_GRAPHS           = YES
 UML_LOOK               = YES
 TEMPLATE_RELATIONS     = YES
 INCLUDE_GRAPH          = YES
-INCLUDED_BY_GRAPH      = YES
+INCLUDED_BY_GRAPH      = NO
 CALL_GRAPH            = YES
 CALLER_GRAPH           = NO
 GRAPHICAL_HIERARCHY    = YES
 DIRECTORY_GRAPH        = YES
 DOT_IMAGE_FORMAT       = png
-DOT_PATH               = @DOT_PATH@
+DOT_PATH               = @DOXYGEN_DOT_PATH@
+#DOT_GRAPH_MAX_NODES    = 100
 DOTFILE_DIRS           = 
 MAX_DOT_GRAPH_DEPTH    = 0
 GENERATE_LEGEND        = YES
index d7b9f68..7ada94c 100644 (file)
@@ -84,9 +84,6 @@
     - @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>
     
     - <a class="el" href="http://aliceinfo.cern.ch">
           The ALICE Experiment </a> 
-    - <a class="el" href="http://www.kip.uni-heidelberg.de/wiki/HLT">
+    - <a class="el" href="https://twiki.cern.ch/twiki/bin/viewauth/ALICEHLT/">
           The ALICE High Level Trigger web pages </a> 
     - <a class="el" href="http://aliceinfo.cern.ch/Offline">
           The ALICE Offline web pages </a> 
diff --git a/HLT/doc/module_group.c b/HLT/doc/module_group.c
new file mode 100644 (file)
index 0000000..b69435d
--- /dev/null
@@ -0,0 +1,17 @@
+
+/** @file module_group.c
+    @brief Detector modules references. */
+
+/** @defgroup alihlt_modules HLT Detector Modules
+
+    Available detector modules:
+    - @ref alihlt_tpc
+    - @ref alihlt_global
+
+*/
+
+
+#error Not for compilation
+//
+// EOF
+//
index 33d26aa..f700000 100644 (file)
@@ -39,7 +39,7 @@ struct AliHLTTracksData;
  *      AliESDZDC,AliESDFMD,Cascades,Kinks,AliRawDataErrorLogs,AliESDACORDE
  *      leave blank to disable the option
  *
- * @ingroup alihlt_tpc_components
+ * @ingroup alihlt_global_components
  */
 class AliHLTGlobalEsdConverterComponent : public AliHLTProcessor
 {
index f75b239..ec753d5 100644 (file)
@@ -48,7 +48,7 @@ class TH2;
  * the form "_Slice_%.2d%.2d_Partition_%.2d%.2d, minSlice, maxSlice, minPartition, maxPartition".
  * It keeps the first part of the hist name and uses it to name the summed histogram.
  *
- * @ingroup alihlt_tpc
+ * @ingroup alihlt_global
  */
 class AliHLTGlobalHistoCollector : public AliHLTProcessor {
     
index 60e4a5a..4c77c73 100644 (file)
@@ -52,7 +52,7 @@
  * <h2>Output size:</h2>
  * Depending on the mode.
  *
- * @ingroup alihlt_util_components
+ * @ingroup alihlt_global_components
  */
 class AliHLTGlobalHistoComponent : public AliHLTTTreeProcessor
 {
index 87ea4a9..c81889f 100644 (file)
@@ -87,7 +87,7 @@ Int_t AliHLTGlobalTrackMatcher::AddTrackToCluster(Int_t tId, TArrayI* matchedTra
   return nMatches;
 }
 
-Int_t AliHLTGlobalTrackMatcher::AddTrackToCluster(Int_t tId, Int_t* matchArray, bool bestMatch, Int_t nMatches ){
+Int_t AliHLTGlobalTrackMatcher::AddTrackToCluster(Int_t tId, Int_t* clustersArray, Bool_t bestMatch, Int_t nMatches ){
 
   //  HLTInfo("Adding track %d to cluster with %d previous matches", tId, nMatches);
   
@@ -99,10 +99,10 @@ Int_t AliHLTGlobalTrackMatcher::AddTrackToCluster(Int_t tId, Int_t* matchArray,
  
    
   if(bestMatch) {
-    matchArray[nMatches] = matchArray[0];
-    matchArray[0] = tId;
+    clustersArray[nMatches] = clustersArray[0];
+    clustersArray[0] = tId;
   } else  {
-    matchArray[nMatches] = tId;
+    clustersArray[nMatches] = tId;
   }
 
   return nMatches;
diff --git a/HLT/global/docalihltglobal.c b/HLT/global/docalihltglobal.c
new file mode 100644 (file)
index 0000000..c787023
--- /dev/null
@@ -0,0 +1,34 @@
+// $Id$
+
+//**************************************************************************
+//* This file is property of and copyright by the ALICE HLT Project        * 
+//* ALICE Experiment at CERN, All rights reserved.                         *
+//*                                                                        *
+//* Permission to use, copy, modify and distribute this software and its   *
+//* documentation strictly for non-commercial purposes is hereby granted   *
+//* without fee, provided that the above copyright notice appears in all   *
+//* copies and that both the copyright notice and this permission notice   *
+//* appear in the supporting documentation. The authors make no claims     *
+//* about the suitability of this software for any purpose. It is          *
+//* provided "as is" without express or implied warranty.                  *
+//**************************************************************************
+
+/** @file   docalihltglobal.c
+    @brief  Library documentation for the libAliHLTGlobal library.
+*/
+
+/** 
+@defgroup alihlt_global The libAliHLTGlobal library
+@ingroup alihlt_modules
+*/
+
+/**
+@defgroup alihlt_global_components Global HLT components
+@ingroup alihlt_global
+*/
+
+
+#error Not for compilation
+//
+// EOF
+//
index 9e9fa85..5182d60 100644 (file)
@@ -14,7 +14,7 @@
  **************************************************************************/
 
 /** 
- * @file   AliHLTCaloHistoCellEnergy
+ * @file   AliHLTCaloHistoCellEnergy.cxx
  * @author Svein Lindal
  * @date 
  * @brief  Produces histograms of cluster energy distributions 
index d46dbca..98bf07c 100644 (file)
@@ -7,7 +7,7 @@
 //* See cxx source for full Copyright notice                               *
 
 /** 
- * @file   AliHLTCaloHistoCellEnergy
+ * @file   AliHLTCaloHistoCellEnergy.h
  * @author Svein Lindal <slindal@fys.uio.no>
  * @date 
  * @brief  Produces Invariant mass histograms of PHOS clusters
@@ -39,7 +39,7 @@ class TString;
  * Histograms (1D):
  *  * - Invariant mass of two clusters
  * 
- * @ingroup alihlt_phos
+ * @ingroup alihlt_global
  */
 
 
index b3c70e7..e9daea1 100644 (file)
@@ -14,7 +14,7 @@
  **************************************************************************/
 
 /** 
- * @file   AliHLTCaloHistoClusterEnergy
+ * @file   AliHLTCaloHistoClusterEnergy.cxx
  * @author Svein Lindal
  * @date 
  * @brief  Produces histograms of cluster energy distributions 
index bf0c3d3..76b8c4b 100644 (file)
@@ -17,7 +17,7 @@
 #define ALIHLTCALOHISTOCLUSTERENERGY
 
 /** 
- * @file   AliHLTCaloHistoClusterEnergy
+ * @file   AliHLTCaloHistoClusterEnergy.cxx
  * @author Svein Lindal slindal@fys.uio.no
  * @date 
  * @brief  Produces histograms of cluster energy distributions
@@ -51,7 +51,7 @@ class TString;
  * 
  * 
  * 
- * @ingroup alihlt_phos
+ * @ingroup alihlt_global
  */
 
 class AliHLTCaloHistoClusterEnergy : public AliHLTCaloHistoProducer {
index 826146c..0f26c71 100644 (file)
@@ -45,10 +45,10 @@ class TRefArray;
 class AliHLTCaloClusterReader;
 class TObjArray;
 /**
- * @class AliHLTPHOSHistogramProducerComponent
+ * @class AliHLTCaloHistoComponent
  *
  * 
- * @ingroup alihlt_phos
+ * @ingroup alihlt_global
  */
 
 class AliHLTCaloHistoComponent : public AliHLTProcessor {
index eb90e2b..fc5467c 100644 (file)
@@ -15,7 +15,7 @@
  **************************************************************************/
 
 /** 
- * @file   AliHLTCaloHistoInvMass
+ * @file   AliHLTCaloHistoInvMass.cxx
  * @author Svein Lindal <slindal@fys.uio.no>
  * @date 
  * @brief  Produces plots of invariant mass of two clusters. 
index 2f80372..35bbc34 100644 (file)
@@ -18,7 +18,7 @@
 #define ALIHLTCALOHISTOINVMASS_H
 
 /** 
- * @file   AliHLTCaloHistoInvMass
+ * @file   AliHLTCaloHistoInvMass.h
  * @author Albin Gaignette and Svein Lindal slindal@fys.uio.no
  * @date 
  * @brief  Produces Invariant mass histograms of PHOS clusters
@@ -49,7 +49,7 @@ class TH1F;
  * Histograms (1D):
  *  * - Invariant mass of two clusters
  * 
- * @ingroup alihlt_phos
+ * @ingroup alihlt_global
  */
 
 using std::vector;
index 718a4f1..3d06c3e 100644 (file)
@@ -15,7 +15,7 @@
  **************************************************************************/
 
 /** 
- * @file   AliHLTPHOSMatchedclustershistoProducer
+ * @file   AliHLTCaloHistoMatchedTracks.cxx
  * @author Albin Gaignette
  * @date 
  * @brief  Base Class for the Calo Matched track histograms
index cc1fa4d..be852cc 100644 (file)
@@ -7,7 +7,7 @@
 //* See cxx source for full Copyright notice                               *
 
 /** 
- * @file   AliHLTCaloHistoMatchedTracks
+ * @file   AliHLTCaloHistoMatchedTracks.h
  * @author Albin Gaignette and Svein Lindal slindal@fys.uio.no
  * @date 
  * @brief  Produces Invariant mass histograms of PHOS clusters
@@ -34,7 +34,7 @@ class TH2F;
  * Class produces physics histograms for PHOS. It takes a TClonesArray
  * of AliESDCalocluster as input and fills several histograms
  *
- * @ingroup alihlt_phos
+ * @ingroup alihlt_global
  */
 
 
index 715fd6d..a8f5b11 100644 (file)
@@ -15,7 +15,7 @@
  **************************************************************************/
 
 /** 
- * @file   AliHLTCaloHistoProducer
+ * @file   AliHLTCaloHistoProducer.cxx
  * @author Svein Lindal <slindal@fys.uio.no>
  * @date 
  * @brief  Base class for Calo Physics histogram producers
index c9be4e7..1101391 100644 (file)
@@ -18,7 +18,7 @@
 #define ALIHLTCALOHISTOPRODUCER_H
 
 /** 
- * @file   AliHLTCaloHistoProducer
+ * @file   AliHLTCaloHistoProducer.h
  * @author Svein Lindal slindal@fys.uio.no
  * @date 
  * @brief  Base class for calo physics histogram producers
@@ -46,7 +46,7 @@ class TObjArray;
  * Base class for calo physics histogram producers
  *
  *
- * @ingroup alihlt_phos
+ * @ingroup alihlt_global
  */
 
 using std::vector;
index 02ed8a6..7421a0c 100644 (file)
@@ -34,7 +34,7 @@ class TH1;
 /**
  * @class AliHLTMultiplicityCorrelations
  *
- * @ingroup alihlt_physics
+ * @ingroup alihlt_global
  */
 
 class AliHLTMultiplicityCorrelations : public TNamed, public AliHLTLogging {
index 7c5478f..1582f5f 100644 (file)
@@ -114,7 +114,7 @@ class AliHLTGlobalTriggerDecision;
  * <tt>macros/runMultiplicityCorrelationsTest.sh</tt>
  * \li - Run Test macro HLTMultiplicityCorrelationsTest.C
  *
- * @ingroup alihlt_physics
+ * @ingroup alihlt_global_components
  */
 class AliHLTMultiplicityCorrelationsComponent : public AliHLTProcessor {
 public:
index bf4d899..8bfa0c6 100644 (file)
@@ -7,7 +7,7 @@
  * Results are written to disk by a rootfile writer
  *
  * @author Jochen Thaeder <jochen@thaeder.de>
- * @ingroup alihlt_physics
+ * @ingroup alihlt_global
  */
 
 
index 5d86bc3..557fe08 100644 (file)
@@ -22,7 +22,7 @@
  *  - ""  <pre> aliroot -b -q makeConfigurationObjectMultiplicityCorrelations.C </pre>
  *
  * @author Jochen Thaeder <jochen@thaeder.de>
- * @ingroup alihlt_physics
+ * @ingroup alihlt_global
  */
 void makeConfigurationObjectMultiplicityCorrelations(const Char_t* param="-addTrigger CPBI1 -addTrigger CPBI2", const Char_t* cdbUri=NULL,
                                                     Int_t runMin=0, Int_t runMax=AliCDBRunRange::Infinity(),
index 9553080..8f275c4 100644 (file)
@@ -22,7 +22,7 @@
  *
  * @author Chiara Oppedisano <Chiara.Oppedisano@to.infn.it>
  *         Jochen Thaeder <jochen@thaeder.de>
- * @ingroup alihlt_zdc
+ * @ingroup alihlt_global
  */
 void makeConfigurationObjectdNdPtAnalysis(const Char_t* param="-vertexZRange 20. -meanVertexXYZ 0. 0. 0. -meanVertexXYZSigma 1. 1. 10. -etaRange 0.9 -ptRange 0.15 1.e10 -maxDCAr 3.0 -maxDCAz 30.0 -maxDCAToVertexXY 3.0 -maxDCAToVertexZ 3.0 -requireSigmaToVertex 1", const Char_t* cdbUri=NULL,
                                          Int_t runMin=0, Int_t runMax=AliCDBRunRange::Infinity()) {
index 28c99b0..207da09 100644 (file)
@@ -1,6 +1,6 @@
 // $Id$
 /**
- * @ingroup trigger_manus
+ * @ingroup trigger_menus
  * @file HM_PHYSICS_V0001.C
  * @brief Macro for generating the trigger menu CDB entry for the HLT global trigger.
  *