minor changes in code documentation

diff --git a/HLT/SampleLib/README b/HLT/SampleLib/README
index 0c8362ecf1dc86272d0d84b6824ea133cb965ecb..6f56c62e40138f306e30baf783abd9f2bc1f52e3 100644 (file)
--- a/HLT/SampleLib/README
+++ b/HLT/SampleLib/README
@@ -29,16 +29,16 @@ as 'topdir' from now on.
 1. Choose a name for your library and the sub-folder: 
    e.g. 'libAliHLTTest' in folder 'Test'
 2. Go to the topdir:
-> cd <topdir>
+$ cd <topdir>
 
 3. Copy the SampleLib folder as new 'Test' folder
-> cp -a SampleLib Test
+$ cp -a SampleLib Test
 
 4. Copy libAliHLTSample.pkg to libAliHLTTest.pkg
-> cp libAliHLTSample.pkg libAliHLTTest.pkg
+$ cp libAliHLTSample.pkg libAliHLTTest.pkg
 
 5. Change dir to the new folder
-> cd Test
+$ cd Test
 
 6. Open 'Makefile.am' with an editor
    This is the Makefile template for the autotools build system. In particular
@@ -55,10 +55,10 @@ as 'topdir' from now on.
    - AliHLTSampleComponent1/2: two dummy components which just demonstrate 
      how several components can be implemented in one library
    Each of the components has a header file '<component>.h' and a source code
-   file '<component>.cxx
+   file '<component>.cxx'
 7.1 Take the DummyComponent, copy the two files (to your component name):
-> cp AliHLTDummyComponent.h MyTestComponent.h
-> cp AliHLTDummyComponent.cxx MyTestComponent.cxx
+$ cp AliHLTDummyComponent.h MyTestComponent.h
+$ cp AliHLTDummyComponent.cxx MyTestComponent.cxx
 7.2 Implement the required methods. A tutorial will be added to this package
    soon. A comprehensive online tutorial is available at
    http://www.kip.uni-heidelberg.de/wiki/HLT
@@ -82,8 +82,8 @@ as 'topdir' from now on.
 10.Make sure that all files are saved. Now follow the instruction from the
    README in the topdir. In principle its enough to go to your build directory
    and simply type
-> make
-> make install
+$ make
+$ make install
 
 
 

diff --git a/HLT/TPCLib/comp/AliHLTTPCCompDumpComponent.h b/HLT/TPCLib/comp/AliHLTTPCCompDumpComponent.h
index 6c473bbeebc99a4471ac235bb845142f318d46e9..cbdece175872398a16a74a2bcb723ec48fc0ef6b 100644 (file)
--- a/HLT/TPCLib/comp/AliHLTTPCCompDumpComponent.h
+++ b/HLT/TPCLib/comp/AliHLTTPCCompDumpComponent.h
@@ -19,7 +19,7 @@
  * @class AliHLTTPCCompDumpComponent
  * @author Timm Steinbeck
  * @brief A dummy HLT processing component. 
- * @data 05-03-2008
+ * @date 05-03-2008
  *
  * An implementiation of a copy component that just copies its input data
  * to debug a components input data

diff --git a/HLT/doc/Makefile.am b/HLT/doc/Makefile.am
index 831b1184025b090f77066ba5d95c04d8c52b9b24..94b88b0703d7ab8ab2a73b50705e910d7b5d9dd7 100644 (file)
--- a/HLT/doc/Makefile.am
+++ b/HLT/doc/Makefile.am
@@ -63,7 +63,7 @@ all-local:$(HTML) $(PDF) $(MODULES)
 
 
 clean-local: 
-       rm -rf *~ html latex man readme.c
+       rm -rf *~ html latex man readme.c sample_readme.c
 
 readme.c: @top_srcdir@/README
        @cat $< | sed -e '/^=/s|=||g' -e '/^-/s|-||g'                     | \
@@ -88,7 +88,20 @@ readme.c: @top_srcdir@/README
        @echo '*/'                                                       >> $@
        @rm $@_work
 
-$(HTML) $(PACKAGE).tags: doxygen.conf Makefile mainpage.c readme.c
+sample_readme.c: @top_srcdir@/SampleLib/README
+       @echo '/** @file sample_readme.c'                                 > $@
+       @echo '    @author Matthias Richter'                             >> $@
+       @echo '    @brief  autogenerated from SampleLib/README.'         >> $@
+       @echo '*/'                                                       >> $@
+       @echo '/** '                                                     >> $@
+       @echo '    @page sample_readme Creating a new Library'           >> $@
+       @echo '<pre>'                                                    >> $@
+       @cat $<                                                          | \
+       sed -e 's|<|\&lt;|g' -e 's|>|\&gt;|g'                            >> $@
+       @echo '</pre>'                                                   >> $@
+       @echo '*/'                                                       >> $@
+
+$(HTML) $(PACKAGE).tags: doxygen.conf Makefile mainpage.c readme.c sample_readme.c
        $(DOXYGEN) $<  
 
 %.conf: doxymodule.conf Makefile

diff --git a/HLT/doc/doxygen.conf.in b/HLT/doc/doxygen.conf.in
index 6559757ec7de9bf0ecb8c79e653eac33a8379ccd..4be1a0d7588893ed3ac01e1151c3312259a5b0f8 100644 (file)
--- a/HLT/doc/doxygen.conf.in
+++ b/HLT/doc/doxygen.conf.in
@@ -64,6 +64,7 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 INPUT                  = @top_srcdir@/doc      \
                         readme.c               \
+                        sample_readme.c        \
                         @top_srcdir@/BASE      \
                         @top_srcdir@/TPCLib    \
                         @top_srcdir@/SampleLib \