project documentation split into separate doxygen modules for detector libraries
authorrichterm <richterm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 2 May 2008 13:49:18 +0000 (13:49 +0000)
committerrichterm <richterm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 2 May 2008 13:49:18 +0000 (13:49 +0000)
12 files changed:
HLT/BASE/AliHLTEventStatistics.h
HLT/MUON/docalihltmuon.c [new file with mode: 0644]
HLT/PHOS/docalihltphos.c [new file with mode: 0644]
HLT/RCU/docalihltrcu.c [new file with mode: 0644]
HLT/TPCLib/docalihlttpc.c
HLT/TRD/docalihlttrd.c [new file with mode: 0644]
HLT/comp/docalihltcomp.c [new file with mode: 0644]
HLT/doc/Makefile.am
HLT/doc/doxygen.conf.in
HLT/doc/doxymodule.conf.in
HLT/doc/mainpage.c
HLT/trigger/docalihlttrigger.c [new file with mode: 0644]

index 4dd11efe68303bde780d3eecbc82417acd40ad8e..ba6afa01b0ff2c2ba9f832e4f2db2b8d1f19f709 100644 (file)
@@ -28,6 +28,7 @@
 /**
  * @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"
diff --git a/HLT/MUON/docalihltmuon.c b/HLT/MUON/docalihltmuon.c
new file mode 100644 (file)
index 0000000..b4939fc
--- /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   docalihltmuon.c
+    @brief  Library documentation for the libAliHLTMUON library.
+*/
+
+/** 
+@defgroup alihlt_muon The libAliHLTMUON library
+@ingroup alihlt_modules
+*/
+
+/**
+@defgroup alihlt_muon_components MUON HLT components
+@ingroup alihlt_muon
+*/
+
+
+#error Not for compilation
+//
+// EOF
+//
diff --git a/HLT/PHOS/docalihltphos.c b/HLT/PHOS/docalihltphos.c
new file mode 100644 (file)
index 0000000..7d7641e
--- /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   docalihltphos.c
+    @brief  Library documentation for the libAliHLTPHOS library.
+*/
+
+/** 
+@defgroup alihlt_phos The libAliHLTPHOS library
+@ingroup alihlt_modules
+*/
+
+/**
+@defgroup alihlt_phos_components PHOS HLT components
+@ingroup alihlt_phos
+*/
+
+
+#error Not for compilation
+//
+// EOF
+//
diff --git a/HLT/RCU/docalihltrcu.c b/HLT/RCU/docalihltrcu.c
new file mode 100644 (file)
index 0000000..961a5be
--- /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   docalihltrcu.c
+    @brief  Library documentation for the libAliHLTRCU library.
+*/
+
+/** 
+@defgroup alihlt_rcu The libAliHLTRCU library
+@ingroup alihlt_modules
+*/
+
+/**
+@defgroup alihlt_rcu_components RCU HLT components
+@ingroup alihlt_rcu
+*/
+
+
+#error Not for compilation
+//
+// EOF
+//
index fe0d5ac1cda48137b4ba08ebb517dfdd9534452e..8df314cb8f84df6980f821df24d05849e618f108 100644 (file)
@@ -1,33 +1,25 @@
 // $Id$
-/************************************************************************
-**
-** This file is property of and copyright by the ALICE HLT Project
-** ALICE Experiment at CERN, All rights reserved.
-**
-** This file is property of and copyright by the Experimental Nuclear 
-** Physics Group, Dep. of Physics and Technology
-** University of Bergen, Norway, 2004
-** This file has been written by Matthias Richter,
-** Matthias.Richter@ift.uib.no
-**
-** 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.                 
-**
-*************************************************************************/
+
+//**************************************************************************
+//* 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   docalihlttpc.c
-    @author Matthias Richter
-    @date   
     @brief  Library documentation for the libAliHLTTPC library.
 */
 
 /** 
 @defgroup alihlt_tpc The libAliHLTTPC library
+@ingroup alihlt_modules
 */
 
 /**
 @ingroup alihlt_tpc
 */
 
-/**
-@defgroup alihlt_tpc_datastructs TPC components data exchange structures
-@ingroup alihlt_tpc
-*/
 
 #error Not for compilation
 //
diff --git a/HLT/TRD/docalihlttrd.c b/HLT/TRD/docalihlttrd.c
new file mode 100644 (file)
index 0000000..dc40893
--- /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   docalihlttrd.c
+    @brief  Library documentation for the libAliHLTTRD library.
+*/
+
+/** 
+@defgroup alihlt_trd The libAliHLTTRD library
+@ingroup alihlt_modules
+*/
+
+/**
+@defgroup alihlt_trd_components TRD HLT components
+@ingroup alihlt_trd
+*/
+
+
+#error Not for compilation
+//
+// EOF
+//
diff --git a/HLT/comp/docalihltcomp.c b/HLT/comp/docalihltcomp.c
new file mode 100644 (file)
index 0000000..f38d364
--- /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   docalihltmuon.c
+    @brief  Library documentation for the libAliHLTComp library.
+*/
+
+/** 
+@defgroup alihlt_comp The libAliHLTComp library
+@ingroup alihlt_modules
+*/
+
+/**
+@defgroup alihlt_comp_components Comp HLT components
+@ingroup alihlt_comp
+*/
+
+
+#error Not for compilation
+//
+// EOF
+//
index 94b88b0703d7ab8ab2a73b50705e910d7b5d9dd7..26a261d66f1b9cd5da4334331f9018b6550b037f 100644 (file)
@@ -1,31 +1,18 @@
 # $Id$
 # Makefile template for the Alice HLT documentation
 #
-#***********************************************************************
-#
-# Alice HLT project
-# Copyright (c) 2005
-#
-# This file is property of and copyright by the Experimental Nuclear 
-# Physics Group, Dep. of Physics and Technology
-# University of Bergen, Norway, 2004
-# This file has been written by Matthias Richter,
-# Matthias.Richter@ift.uib.no
-#
-# 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.                 
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free
-# Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, 
-# MA 02111-1307  USA  
-#
-#***********************************************************************/
+#**************************************************************************
+#* 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.                  *
+#**************************************************************************
 
 EXTRA_DIST             = mainpage.c \
                          pics/HLT-AliRoot-Integration_overview.png \
@@ -37,6 +24,39 @@ EXTRA_DIST           = mainpage.c \
 if HAVE_DOXYGEN
 HTML                   = html/index.html
 MODULES                        = 
+
+if EN_HLT_TPC
+MODULES                        += TPCLib
+endif
+
+if EN_HLT_RCU
+MODULES                        += RCU
+endif
+
+if EN_HLT_PHOS
+MODULES                        += PHOS
+endif
+
+if EN_HLT_TRD
+MODULES                        += TRD
+endif
+
+if EN_HLT_MUON
+MODULES                        += MUON
+endif
+
+if EN_HLT_COMP
+MODULES                        += comp
+endif
+
+if EN_HLT_TRIGGER
+MODULES                        += trigger
+endif
+
+# if EN_HLT_ITS
+# MODULES                      += ITS
+# endif
+
 #PDF                   = latex/refman.pdf
 TAGS                   = $(PACKAGE).tags
 else 
@@ -59,11 +79,11 @@ CLASS_FILTER        = structAliHLTRawBuffer \
 %.png:%.fig
        fig2dev -Lpng $< 
 
-all-local:$(HTML) $(PDF) $(MODULES)
+all-local: $(TAGS) $(MODULES) $(HTML) $(PDF)
 
 
 clean-local: 
-       rm -rf *~ html latex man readme.c sample_readme.c
+       rm -rf *~ html latex man readme.c sample_readme.c module_group.c
 
 readme.c: @top_srcdir@/README
        @cat $< | sed -e '/^=/s|=||g' -e '/^-/s|-||g'                     | \
@@ -73,8 +93,7 @@ readme.c: @top_srcdir@/README
        sed -e '/^  [-()\<a-zA-Z0-9.]/s|\([<>]\)|\\\1|g'                  | \
        sed -e '/^  [-()\<a-zA-Z0-9.]/s|\(.*\)|<tt>  \1</tt><br>|'        | \
        sed -e 's|\!\!\!\!|<b>|' -e 's|\!\!\!|</b>|'                      > $@_work
-       @echo '/** @file readme.c'                                        > $@
-       @echo '    @author Matthias Richter'                             >> $@
+       @echo "/** @file $@"                                              > $@
        @echo '    @brief  autogenerated from README.'                   >> $@
        @echo '    @see  @ref readme                  */'                >> $@
        @echo '/** '                                                     >> $@
@@ -89,8 +108,7 @@ readme.c: @top_srcdir@/README
        @rm $@_work
 
 sample_readme.c: @top_srcdir@/SampleLib/README
-       @echo '/** @file sample_readme.c'                                 > $@
-       @echo '    @author Matthias Richter'                             >> $@
+       @echo "/** @file $@"                                              > $@
        @echo '    @brief  autogenerated from SampleLib/README.'         >> $@
        @echo '*/'                                                       >> $@
        @echo '/** '                                                     >> $@
@@ -101,13 +119,35 @@ sample_readme.c: @top_srcdir@/SampleLib/README
        @echo '</pre>'                                                   >> $@
        @echo '*/'                                                       >> $@
 
-$(HTML) $(PACKAGE).tags: doxygen.conf Makefile mainpage.c readme.c sample_readme.c
+module_group.c: Makefile
+       @echo "/** @file $@"                                              > $@
+       @echo '    @brief  autogenerated from Makefile.'                 >> $@
+       @echo '*/'                                                       >> $@
+       @echo '/** @defgroup alihlt_modules HLT Detector Modules'        >> $@
+       @echo                                                            >> $@
+       @echo 'Available detector modules:'                              >> $@
+       $(foreach m, $(MODULES), echo "- @ref alihlt_`echo $(m) | tr '[:upper:]' '[:lower:]' | sed -e 's|lib||'`" >> $@;)
+       @echo '*/'                                                       >> $@
+
+doxymain.conf: doxygen.conf Makefile
+       @t="$(foreach m, $(MODULES), @PACKAGE@.$(m).tags=$(m))"; \
+       cat $< | sed -e "s|^\(TAGFILES[ ]*=\)|\1 $$t|" -e "/^WARN/s|NO|YES|"> $@
+
+$(TAGS): doxygen.conf mainpage.c readme.c sample_readme.c module_group.c
+       @echo creating main tag file ...
+       $(DOXYGEN) $<  
+
+$(HTML): doxymain.conf $(TAGS)
+       @echo creating main documentation ...
        $(DOXYGEN) $<  
 
 %.conf: doxymodule.conf Makefile
-       cat $< | sed -e "s|@DOXYMODULE@|$(@:.conf=)|" > $@
+       @e=`find $(top_srcdir)/$(@:.conf=) -name configure.ac -exec dirname {} \;`; \
+       e=`echo $$e | tr -d '\n'`; \
+       cat $< | sed -e "s|@DOXYMODULE@|$(@:.conf=)|" -e "s|^\(EXCLUDE[ ]*=\)|\1 $$e|" > $@
 
 html/%/index.html: %.conf
+       @echo creating module ...
        $(DOXYGEN) $<
 
 $(MODULES:%=html/%):
index ebe6786765941c63b03abd2dcd22eeef263ce3fb..7c9333a149660b31b2f2e8d89cdfd8992b0dcd38 100644 (file)
@@ -56,7 +56,7 @@ SHOW_USED_FILES        = YES
 QUIET                  = YES
 WARNINGS               = YES
 WARN_IF_UNDOCUMENTED   = YES
-WARN_IF_DOC_ERROR      = YES
+WARN_IF_DOC_ERROR      = NO
 WARN_FORMAT            = "$file:$line: $text"
 WARN_LOGFILE           = 
 #---------------------------------------------------------------------------
@@ -65,14 +65,12 @@ WARN_LOGFILE           =
 INPUT                  = @top_srcdir@/doc      \
                         readme.c               \
                         sample_readme.c        \
+                        module_group.c         \
                         @top_srcdir@/BASE      \
-                        @top_srcdir@/TPCLib    \
                         @top_srcdir@/SampleLib \
-                        @top_srcdir@/RCU       \
                         @top_srcdir@/rec       \
                         @top_srcdir@/exa       \
-                        @top_srcdir@/sim       \
-                        @top_srcdir@/trigger
+                        @top_srcdir@/sim
 
 FILE_PATTERNS          = *.h *.c *.cpp *.hpp *.cxx *.C
 RECURSIVE              = YES
index cfe7ce0a7c47cbfcbbda2c7ffd0518f1e4554ba8..1bb1188c86434c3a5c8441d4eb0f564bea5ade38 100644 (file)
@@ -54,7 +54,7 @@ SHOW_USED_FILES        = YES
 # configuration options related to warning and progress messages
 #---------------------------------------------------------------------------
 QUIET                  = YES
-WARNINGS               = YES
+WARNINGS               = NO
 WARN_IF_UNDOCUMENTED   = YES
 WARN_IF_DOC_ERROR      = YES
 WARN_FORMAT            = "$file:$line: $text"
@@ -66,7 +66,7 @@ INPUT                  = @top_srcdir@/@DOXYMODULE@
 
 FILE_PATTERNS          = *.h *.c *.cpp *.hpp *.cxx
 RECURSIVE              = YES
-EXCLUDE                = 
+EXCLUDE                = AliHLTDataTypes.*
 
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       = 
index 68314ce08b3212930a9b1c2472491a381d0614d5..64201b5dfd0384ce69e98e81e402b64533d2b57f 100644 (file)
 
     - @ref readme <br>
 
-    @section libraries Component libraries
-
-    - @ref alihlt_tpc <br>
-      HLT TPC module.
-<!--
-    - <a href="tpc/index.html">
-      HLT TPC module.</a>
--->
+    @section libraries Detector/Module libraries
+
+    - @ref alihlt_modules
 
     @section links Related links on the web
     
diff --git a/HLT/trigger/docalihlttrigger.c b/HLT/trigger/docalihlttrigger.c
new file mode 100644 (file)
index 0000000..c74211c
--- /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   docalihltmuon.c
+    @brief  Library documentation for the libAliHLTTrigger library.
+*/
+
+/** 
+@defgroup alihlt_trigger The libAliHLTTrigger library
+@ingroup alihlt_modules
+*/
+
+/**
+@defgroup alihlt_trigger_components Trigger HLT components
+@ingroup alihlt_trigger
+*/
+
+
+#error Not for compilation
+//
+// EOF
+//