Montecarlo doc (help from Ivana)

montecarlo/doc/index.md

+\defgroup montecarlo The Monte Carlo related packages.

montecarlo/eg/doc/index.txt → montecarlo/eg/doc/index.md

-BEGIN_HTML
+\defgroup eg The particles related classes
+\ingroup montecarlo
+
 This directory contains classes with interfaces to the Particle Data Group (PDG)
 data base, a static and dynamic particle class and a decay class framework.
-These classes are extensively used in the VMC (Virtual Monte Carlo). See also
-the following references:
-<ul>
-<li><a href="http://www.slac.stanford.edu/econf/C0303241/proc/papers/THJT006.PDF">The Virtual Monte Carlo paper
-      </A></li>
-<li><a href="http://root.cern.ch/root/vmc/VirtualMC.html">the Virtual Monte Carlo Web page
-    </a></li>
-<li><a href="http://aliceinfo.cern.ch/Offline">The ALICE Offline Project
-      </A></li>
-</ul>
-END_HTML
+
+These classes are extensively used in the VMC (Virtual Monte Carlo).
+See also the following references:
+
+  - [The Virtual Monte Carlo paper](http://www.slac.stanford.edu/econf/C0303241/proc/papers/THJT006.PDF)
+  - [The Virtual Monte Carlo Web page](http://root.cern.ch/root/vmc/VirtualMC.html)
+  - [The ALICE Offline Project](http://aliceinfo.cern.ch/Offline)

montecarlo/pythia6/doc/index.md

+\defgroup pythia6 The Pythia6 interface
+\ingroup montecarlo
+
+The pythia6 directory is an interface to the F77 version of Pythia 6.2 event generators, written by T.Sjostrand.
+
+See also the [complete Pythia6 documentation](http://home.thep.lu.se/~torbjorn/pythiaaux/recent.html)
+

montecarlo/pythia8/doc/index.txt → montecarlo/pythia8/doc/index.md

-BEGIN_HTML
-<p>
-The pythia8 directory is an interface to the C++ version of Pythia 8.1
-event generators, written by T.Sjostrand.
-<p>
+\defgroup pythia8 The Pythia8 interface
+\ingroup montecarlo
+\author T.Sjostrand.
+
+The pythia8 directory is an interface to the C++ version of Pythia 8.1 event generators.
+
 The user is assumed to be familiar with the Pythia8 package.
 Only a basic interface to Pythia8 is provided. Because Pythia8 is
 also written in C++, its functions/classes can be called directly from a
 compiled C++ script.
 To call Pythia functions not available in this interface a dictionary must
 be generated.
-<p>
-see $ROOTSYS/tutorials/pythia/pythia8.C for an example of use from CINT.
-END_HTML
+
+See pythia8.C for an example of use from ROOT interpreter.

montecarlo/vmc/doc/index.md

-\defgroup vmc The VirtuaL MONTE CARLO classes.
+\defgroup vmc VirtuaL Monte Carlo
+\ingroup montecarlo
 
 More details can be found in [the Virtual Monte Carlo documentation](https://root.cern.ch/vmc).
 

tutorials/pythia/index.md

+\defgroup tutorial_pythia Pythia tutorials
+\ingroup Tutorials
+\brief Examples showing the pythia usage.

tutorials/pythia/pythia8.C

-// pythia8 basic example
-//Author: Andreas Morsch
-//
-// to run, do
-//  root > .x pythia8.C
-//
-// Note that before executing this script,
-//   -the env variable PYTHIA8 must point to the pythia8100 (or newer) directory
-//   -the env variable PYTHIA8DATA must be defined and it must point to $PYTHIA8/xmldoc
-//
+/// \file
+/// \ingroup tutorial_pythia
+/// pythia8 basic example
+///
+/// to run, do:
+///
+/// ~~~ {.cpp}
+///  root > .x pythia8.C
+/// ~~~
+///
+/// \macro_image
+/// \macro_output
+///
+/// Note that before executing this script,
+///
+///  - the env variable PYTHIA8 must point to the pythia8100 (or newer) directory
+///  - the env variable PYTHIA8DATA must be defined and it must point to $PYTHIA8/xmldoc
+///
+/// \macro_code
+///
+/// \author Andreas Morsch
+
 void pythia8(Int_t nev  = 100, Int_t ndeb = 1)
 {
    const char *p8dataenv = gSystem->Getenv("PYTHIA8DATA");

tutorials/pythia/pythiaExample.C

-//____________________________________________________________________
-//
-// Using Pythia6 with ROOT
-// To make an event sample (of size 100) do
-//
-//    shell> root
-//    root [0] .L pythiaExample.C
-//    root [1] makeEventSample(1000)
-//
-// To start the tree view on the generated tree, do
-//
-//    shell> root
-//    root [0] .L pythiaExample.C
-//    root [1] showEventSample()
-//
-//
-// The following session:
-//    shell> root
-//    root [0] .x pythiaExample.C(500)
-// will execute makeEventSample(500) and showEventSample()
-//
-// Alternatively, you can compile this to a program
-// and then generate 1000 events with
-//
-//    ./pythiaExample 1000
-//
-// To use the program to start the viewer, do
-//
-//    ./pythiaExample -1
-//
-// NOTE 1: To run this example, you must have a version of ROOT
-// compiled with the Pythia6 version enabled and have Pythia6 installed.
-// The statement gSystem->Load("$HOME/pythia6/libPythia6");  (see below)
-// assumes that the directory containing the Pythia6 library
-// is in the pythia6 subdirectory of your $HOME.  Locations
-// that can specify this, are:
-//
-//  Root.DynamicPath resource in your ROOT configuration file
-//    (/etc/root/system.rootrc or ~/.rootrc).
-//  Runtime load paths set on the executable (Using GNU ld,
-//    specified with flag `-rpath').
-//  Dynamic loader search path as specified in the loaders
-//    configuration file (On GNU/Linux this file is
-//    etc/ld.so.conf).
-//  For Un*x: Any directory mentioned in LD_LIBRARY_PATH
-//  For Windows: Any directory mentioned in PATH
-//
-// NOTE 2: The example can also be run with ACLIC:
-//  root > gSystem->Load("libEG");
-//  root > gSystem->Load("$ROOTSYS/../pythia6/libPythia6"); //change to your setup
-//  root > gSystem->Load("libEGPythia6");
-//  root > .x pythiaExample.C+
-//
-//
-//____________________________________________________________________
-//
-// Author: Christian Holm Christensen <cholm@hilux15.nbi.dk>
-// Update: 2002-08-16 16:40:27+0200
-// Copyright: 2002 (C) Christian Holm Christensen
-// Copyright (C) 2006, Rene Brun and Fons Rademakers.
-// For the licensing terms see $ROOTSYS/LICENSE.
-//
+/// \file
+/// \ingroup tutorial_pythia
+/// Using Pythia6 with ROOT
+/// To make an event sample (of size 100) do
+///
+/// ~~~ {.cpp}
+///    shell> root
+///    root [0] .L pythiaExample.C
+///    root [1] makeEventSample(1000)
+/// ~~~
+///
+/// To start the tree view on the generated tree, do
+///
+/// ~~~ {.cpp}
+///    shell> root
+///    root [0] .L pythiaExample.C
+///    root [1] showEventSample()
+/// ~~~
+///
+/// The following session:
+///
+/// ~~~ {.cpp}
+///    shell> root
+///    root [0] .x pythiaExample.C(500)
+/// ~~~
+///
+/// will execute makeEventSample(500) and showEventSample()
+///
+/// Alternatively, you can compile this to a program
+/// and then generate 1000 events with
+///
+/// ~~~ {.cpp}
+///    ./pythiaExample 1000
+/// ~~~
+///
+/// To use the program to start the viewer, do
+///
+/// ~~~ {.cpp}
+///    ./pythiaExample -1
+/// ~~~
+///
+/// NOTE 1: To run this example, you must have a version of ROOT
+/// compiled with the Pythia6 version enabled and have Pythia6 installed.
+/// The statement `gSystem->Load("$HOME/pythia6/libPythia6");`  (see below)
+/// assumes that the directory containing the Pythia6 library
+/// is in the pythia6 subdirectory of your $HOME.  Locations
+/// that can specify this, are:
+///
+/// ~~~ {.cpp}
+///  Root.DynamicPath resource in your ROOT configuration file
+///    (/etc/root/system.rootrc or ~/.rootrc).
+///  Runtime load paths set on the executable (Using GNU ld,
+///    specified with flag `-rpath').
+///  Dynamic loader search path as specified in the loaders
+///    configuration file (On GNU/Linux this file is
+///    etc/ld.so.conf).
+///  For Un*x: Any directory mentioned in LD_LIBRARY_PATH
+///  For Windows: Any directory mentioned in PATH
+/// ~~~
+///
+/// NOTE 2: The example can also be run with ACLIC:
+///
+/// ~~~ {.cpp}
+///  root > gSystem->Load("libEG");
+///  root > gSystem->Load("$ROOTSYS/../pythia6/libPythia6"); //change to your setup
+///  root > gSystem->Load("libEGPythia6");
+///  root > .x pythiaExample.C+
+/// ~~~
+///
+/// \macro_code
+///
+/// \author Christian Holm Christensen
+
 #ifndef __CINT__
 #include "TApplication.h"
 #include "TPythia6.h"
@@ -241,8 +252,3 @@ int main(int argc, char** argv)
 }
 #endif
 
-//____________________________________________________________________
-//
-// EOF
-//
-