Skip to content

Updates in Doxygen: #5005

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ktf merged 1 commit into from
Dec 4, 2020
Merged

Updates in Doxygen: #5005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Detectors/DCS/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,7 @@ auto dps = o2::dcs::generateRandomDataPoints(patterns,0.0,1200.0);
```

would generate 420 data points.

<!-- doxy
* \subpage refDetectorsDCStestWorkflow
/doxy -->
4 changes: 4 additions & 0 deletions Detectors/DCS/testWorkflow/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!-- doxy
\page refDetectorsDCStestWorkflow testWorkflow
/doxy -->

Local example workflow with local CCDB (running on port 6464) :

```shell
Expand Down
1 change: 1 addition & 0 deletions Detectors/FIT/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ This is a top page for the FIT detector documentation.
<!-- doxy
* \subpage refFITbenchmark
* \subpage refFITFT0workflow
* \subpage refFITraw
/doxy -->
4 changes: 4 additions & 0 deletions Detectors/FIT/raw/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!-- doxy
\page refFITraw FIT raw
/doxy -->

# DataBlockBase
DataBlockWrapper - wrapper for raw data structures\
There should be three static fields in raw data structs, which defines its "signature":\
Expand Down
2 changes: 2 additions & 0 deletions Detectors/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ This module contains the following submodules:
* \subpage refDetectorsCalibration
* \subpage refDetectorsCPV
* \subpage refDetectorsCTF
* \subpage refDetectorsDCS
* \subpage refDetectorsEMCAL
* \subpage refDetectorsDCS
* \subpage refDetectorsFIT
Expand All @@ -29,5 +30,6 @@ This module contains the following submodules:
* \subpage refDetectorsTOF
* \subpage refDetectorsTPC
* \subpage refDetectorsTRD
* \subpage refDetectorsUpgrades
* \subpage refDetectorsZDC
/doxy -->
4 changes: 4 additions & 0 deletions Detectors/Upgrades/IT3/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!-- doxy
\page refDetectorsUpgradesIT3 UpgradesIT3
/doxy -->

# IT3
Upgraded version of the ITS that includes upgraded truly-cylindrical inner barrel.

Expand Down
4 changes: 4 additions & 0 deletions Detectors/Upgrades/PostLS4/IT4/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!-- doxy
\page refDetectorsUpgradesPostLS4IT4 UpgradesIT4
/doxy -->

# IT4
At the moment the IT4 name is a placeholder for barrel detector.

Expand Down
8 changes: 4 additions & 4 deletions Detectors/Upgrades/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- doxy
\page refDetectorsITSMFT ITSMFT
\page refDetectorsUpgrades Upgrades
/doxy -->

# Upgrades
Expand All @@ -14,6 +14,6 @@ ENABLE_UPGRADES=ON aliBuild build O2 --defaults o2
```

<!-- doxy
* \subpage refIT3
* \subpage refPostLS4
/doxy -->
* \subpage refDetectorsUpgradesIT3
* \subpage refDetectorsUpgradesPostLS4IT4
/doxy -->
4 changes: 4 additions & 0 deletions Utilities/DataSampling/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!-- doxy
\page refUtilitiesDataSampling Data Sampling
/doxy -->

## Data Sampling

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).
Expand Down
1 change: 1 addition & 0 deletions Utilities/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ This module contains the following submodules:

* \subpage refUtilitiesDataCompression
* \subpage refUtilitiesDataFlow
* \subpage refUtilitiesDataSampling
* \subpage refUtilitiesMCStepLogger
* \subpage refUtilitiesMergers
* \subpage refUtilitiesO2Device
Expand Down
1 change: 1 addition & 0 deletions doc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ This module contains the documentation pages.
* \subpage refdocDoxygenInstructions
* \subpage refdocManPages
* \subpage refdocUpgrades
* \subpage refprodtestsfull-system-test
/doxy -->
Loading