Enhanced doxygen documentation
[u/mrichter/AliRoot.git] / HLT / sim / AliHLTSimulation.h
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: