Skip to content

Commit 662d091

Browse files
mfasDashahor02
authored andcommitted
[EMCAL-622][Doxygen] Create initial EMCAL documentation structure
- Provide inital README.md files for documentation page structure - doxymodules.h: Declaration of EMCAL groups + EMCALbase + EMCALcalib + EMCALsimulation + EMCALreconstruction + EMCALworkflow - Put existing classes into new groups - Align doxygen class header (consiting of at least class,brief, ingroup) where needed - Fix member documentation where needed Documentation is missing in several classes in the EMCAL code. This documentation has to be provided by the users at a later stage.
1 parent d384690 commit 662d091

48 files changed

Lines changed: 351 additions & 270 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Detectors/EMCAL/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- doxy
2+
\page refDetectorsEMCAL EMCAL
3+
/doxy -->
4+
5+
# EMCAL
6+
7+
This is a top page for the EMCAL detector documentation.
8+
9+
<!-- doxy
10+
* \subpage refEMCALsimulation
11+
* \subpage refEMCALreconstruction
12+
* \subpage refEMCALworkflow
13+
/doxy -->

0 commit comments

Comments
 (0)