Skip to content

Commit cbce528

Browse files
ihrivnacihrivnac
authored
Updates in Doxygen: (#5005)
- Disabled class diagrams generation in the default Doxygen configuration file and added doxyfile-with-graphs.in with class diagrams generation kept - Added doxygen keywords where missing to avoid low level documentation pages in the top level
1 parent 41747c1 commit cbce528

File tree

14 files changed

+352
-6
lines changed

14 files changed

+352
-6
lines changed

‎Detectors/DCS/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,7 @@ auto dps = o2::dcs::generateRandomDataPoints(patterns,0.0,1200.0);
1818
```
1919
2020
would generate 420 data points.
21+
22+
<!-- doxy
23+
* \subpage refDetectorsDCStestWorkflow
24+
/doxy -->

‎Detectors/DCS/testWorkflow/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<!-- doxy
2+
\page refDetectorsDCStestWorkflow testWorkflow
3+
/doxy -->
4+
15
Local example workflow with local CCDB (running on port 6464) :
26

37
```shell

‎Detectors/FIT/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@ This is a top page for the FIT detector documentation.
99
<!-- doxy
1010
* \subpage refFITbenchmark
1111
* \subpage refFITFT0workflow
12+
* \subpage refFITraw
1213
/doxy -->

‎Detectors/FIT/raw/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<!-- doxy
2+
\page refFITraw FIT raw
3+
/doxy -->
4+
15
# DataBlockBase
26
DataBlockWrapper - wrapper for raw data structures\
37
There should be three static fields in raw data structs, which defines its "signature":\

‎Detectors/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ This module contains the following submodules:
1818
* \subpage refDetectorsCalibration
1919
* \subpage refDetectorsCPV
2020
* \subpage refDetectorsCTF
21+
* \subpage refDetectorsDCS
2122
* \subpage refDetectorsEMCAL
2223
* \subpage refDetectorsDCS
2324
* \subpage refDetectorsFIT
@@ -29,5 +30,6 @@ This module contains the following submodules:
2930
* \subpage refDetectorsTOF
3031
* \subpage refDetectorsTPC
3132
* \subpage refDetectorsTRD
33+
* \subpage refDetectorsUpgrades
3234
* \subpage refDetectorsZDC
3335
/doxy -->

‎Detectors/Upgrades/IT3/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<!-- doxy
2+
\page refDetectorsUpgradesIT3 UpgradesIT3
3+
/doxy -->
4+
15
# IT3
26
Upgraded version of the ITS that includes upgraded truly-cylindrical inner barrel.
37

‎Detectors/Upgrades/PostLS4/IT4/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<!-- doxy
2+
\page refDetectorsUpgradesPostLS4IT4 UpgradesIT4
3+
/doxy -->
4+
15
# IT4
26
At the moment the IT4 name is a placeholder for barrel detector.
37

‎Detectors/Upgrades/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- doxy
2-
\page refDetectorsITSMFT ITSMFT
2+
\page refDetectorsUpgrades Upgrades
33
/doxy -->
44

55
# Upgrades
@@ -14,6 +14,6 @@ ENABLE_UPGRADES=ON aliBuild build O2 --defaults o2
1414
```
1515

1616
<!-- doxy
17-
* \subpage refIT3
18-
* \subpage refPostLS4
19-
/doxy -->
17+
* \subpage refDetectorsUpgradesIT3
18+
* \subpage refDetectorsUpgradesPostLS4IT4
19+
/doxy -->

‎Utilities/DataSampling/README.md‎

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

37
Data Sampling provides a possibility to sample data in DPL workflows based on certain conditions ( 5% randomly, when a payload is greater than 4234 bytes, etc.). The job of passing the right data is done by a data processor called `Dispatcher`. A desired data stream is specified in form of Data Sampling Policies, configured by JSON structures (example below) or by using dedicated interface methods (for advanced use).

‎Utilities/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ This module contains the following submodules:
1111
1212
* \subpage refUtilitiesDataCompression
1313
* \subpage refUtilitiesDataFlow
14+
* \subpage refUtilitiesDataSampling
1415
* \subpage refUtilitiesMCStepLogger
1516
* \subpage refUtilitiesMergers
1617
* \subpage refUtilitiesO2Device

0 commit comments

Comments
 (0)