Skip to content

Commit 72678b3

Browse files
ihrivnacihrivnac
authored
Doxygen fixes (#13099)
* Updated (or added) Doxygen keywords * Excluded CHANGELOG files from Doxygen documentation
1 parent b04a351 commit 72678b3

File tree

27 files changed

+101
-28
lines changed

27 files changed

+101
-28
lines changed

‎DEBUGGING.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<!-- doxy
2+
\page refdocDebugging How to run in debug mode
3+
/doxy -->
4+
15
# How do I run in debug mode?
26

37
By default, O2 builds with optimizations (`-O2`) turned on, while leaving debug symbols available.

‎Detectors/AOD/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<!-- doxy
2+
\page refDetectorsAOD AOD producers
3+
/doxy -->
4+
15
# AOD producers
26

37
The code in this directory is meant to produce `AO2D.root` output

‎Detectors/CTP/workflowScalers/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<!-- doxy
2+
\page refDetectorsCTP CTP Workflow Scalers
3+
/doxy -->
4+
15
How to generate c++ proto files ?
26
On the computer where project
37
https://gitlab.cern.ch/aliceCTP3/ctp3-ipbus/-/tree/master

‎Detectors/FIT/FT0/base/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<!-- doxy
2+
\page refFITFT0base FT0 Base
3+
/doxy -->
4+
15
# FT0 Base
26

37
## Geometry

‎Detectors/FIT/FV0/base/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<!-- doxy
2+
\page refFITFV0base FV0 Base
3+
/doxy -->
4+
15
# FV0 Base
26

37
## Geometry

‎Detectors/FIT/FV0/reconstruction/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<!-- doxy
2+
\page refFITFV0reconstruction FV0 Reconstyruction
3+
/doxy -->
4+
15
# FV0 reconstruction
26

37
Please note that this readme shows how the reconstruction is done _at the moment_. The current reconstruction is not necessarily done the way it _should be_. The algorithm is under review and subject to change.

‎Detectors/FIT/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ This is a top page for the FIT detector documentation.
99
<!-- doxy
1010
* \subpage refFITbenchmark
1111
* \subpage refFITcommoncalibration
12+
* \subpage refFITFT0base
1213
* \subpage refFITFT0workflow
14+
* \subpage refFITFV0base
15+
* \subpage refFITFV0reconstruction
1316
* \subpage refFITraw
1417
/doxy -->

‎Detectors/HMPID/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ This is a top page for the HMPID detector documentation.
88

99
<!-- doxy
1010
* \subpage refHMPIDworkflow
11+
* \subpage refHMPIDcalibration
1112
/doxy -->

‎Detectors/HMPID/calibration/README.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
#HMPID calibration
1+
<!-- doxy
2+
\page refHMPIDcalibration HMPID calibration
3+
/doxy -->
4+
5+
# HMPID calibration
26

37
For a local test, use
48

‎Detectors/MUON/MCH/README.md‎

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,25 @@
77
This is a top page for the MCH detector documentation.
88

99
<!-- doxy
10-
\subpage refDetectorsMUONMCHCTF
11-
\subpage refDetectorsMUONMCHCalibration
12-
\subpage refDetectorsMUONMCHClustering
13-
\subpage refDetectorsMUONMCHConditions
14-
\subpage refDetectorsMUONMCHContour
15-
\subpage refDetectorsMUONMCHDevIO
16-
\subpage refDetectorsMUONMCHDigitFiltering
17-
\subpage refDetectorsMUONMCHPreClustering
18-
\subpage refDetectorsMUONMCHROFFiltering
19-
\subpage refDetectorsMUONMCHTimeClustering
20-
\subpage refDetectorsMUONMCHGeometry
21-
\subpage refDetectorsMUONMCHMapping
22-
\subpage refDetectorsMUONMCHRaw
23-
\subpage refDetectorsMUONMCHTracking
24-
\subpage refDetectorsMUONMCHTriggering
25-
\subpage refDetectorsMUONMCHWorkflow
26-
\subpage refDetectorsMUONMCHGlobalMapping
27-
\subpage refDetectorsMUONMCHIO
28-
\subpage refDetectorsMUONMCHEvaluation
10+
* \subpage refDetectorsMUONMCHCTF
11+
* \subpage refDetectorsMUONMCHCalibration
12+
* \subpage refDetectorsMUONMCHClustering
13+
* \subpage refDetectorsMUONMCHConditions
14+
* \subpage refDetectorsMUONMCHContour
15+
* \subpage refDetectorsMUONMCHDevIO
16+
* \subpage refDetectorsMUONMCHDigitFiltering
17+
* \subpage refDetectorsMUONMCHPreClustering
18+
* \subpage refDetectorsMUONMCHROFFiltering
19+
* \subpage refDetectorsMUONMCHTimeClustering
20+
* \subpage refDetectorsMUONMCHGeometry
21+
* \subpage refDetectorsMUONMCHMapping
22+
* \subpage refDetectorsMUONMCHRaw
23+
* \subpage refDetectorsMUONMCHSimulation
24+
* \subpage refDetectorsMUONMCHStatus
25+
* \subpage refDetectorsMUONMCHTracking
26+
* \subpage refDetectorsMUONMCHTriggering
27+
* \subpage refDetectorsMUONMCHWorkflow
28+
* \subpage refDetectorsMUONMCHGlobalMapping
29+
* \subpage refDetectorsMUONMCHIO
30+
* \subpage refDetectorsMUONMCHEvaluation
2931
/doxy -->

0 commit comments

Comments
 (0)