📝 Add docstrings to master
#14
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Docstrings generation was requested by @blackcathj. * #13 (comment) The following files were modified: * `generators/Herwig/HepMCTrigger/HepMCJetTrigger.cc` * `generators/Herwig/HepMCTrigger/HepMCParticleTrigger.cc` * `generators/Herwig/HepMCTrigger/HepMCParticleTrigger.h` * `generators/PHPythia8/PHPythia8.cc` * `generators/phhepmc/PHHepMCGenEventv1.cc` * `offline/QA/Calorimeters/CaloValid.cc` * `offline/QA/Tracking/MicromegasClusterQA.cc` * `offline/QA/Tracking/MicromegasClusterQA.h` * `offline/QA/Tracking/StateClusterResidualsQA.cc` * `offline/QA/Tracking/StateClusterResidualsQA.h` * `offline/framework/ffamodules/CDBInterface.cc` * `offline/framework/ffamodules/FlagHandler.h` * `offline/framework/ffamodules/HeadReco.cc` * `offline/framework/ffamodules/HeadReco.h` * `offline/framework/ffamodules/SyncReco.h` * `offline/framework/ffamodules/Timing.cc` * `offline/framework/ffamodules/Timing.h` * `offline/framework/fun4all/Fun4AllServer.cc` * `offline/framework/fun4all/Fun4AllServer.h` * `offline/framework/fun4all/InputFileHandler.cc` * `offline/framework/fun4all/InputFileHandler.h` * `offline/framework/fun4allraw/Fun4AllStreamingInputManager.cc` * `offline/framework/fun4allraw/SingleMicromegasPoolInput_v2.cc` * `offline/framework/fun4allraw/SingleMicromegasPoolInput_v2.h` * `offline/framework/fun4allraw/SingleMvtxPoolInput.cc` * `offline/framework/fun4allraw/SingleTriggeredInput.cc` * `offline/framework/fun4allraw/SingleTriggeredInput.h` * `offline/packages/CaloEmbedding/CombineTowerInfo.cc` * `offline/packages/CaloEmbedding/CombineTowerInfo.h` * `offline/packages/CaloEmbedding/CopyIODataNodes.cc` * `offline/packages/CaloEmbedding/CopyIODataNodes.h` * `offline/packages/CaloReco/PhotonClusterBuilder.cc` * `offline/packages/KFParticle_sPHENIX/KFParticle_sPHENIX.cc` * `offline/packages/PHGenFitPkg/PHGenFit/Fitter.cc` * `offline/packages/PHGenFitPkg/PHGenFit/Track.cc` * `offline/packages/Skimmers/Trigger/TriggerDSTSkimmer.cc` * `offline/packages/Skimmers/Trigger/TriggerDSTSkimmer.h` * `offline/packages/jetbackground/DetermineTowerBackground.cc` * `offline/packages/jetbackground/DetermineTowerBackground.h` * `offline/packages/mbd/MbdCalib.cc` * `offline/packages/mbd/MbdEvent.cc` * `offline/packages/mbd/MbdReco.cc` * `offline/packages/mbd/MbdSig.h` * `offline/packages/micromegas/MicromegasClusterizer.cc` * `offline/packages/micromegas/MicromegasCombinedDataDecoder.cc` * `offline/packages/micromegas/MicromegasCombinedDataDecoder.h` * `offline/packages/micromegas/MicromegasDefs.cc` * `offline/packages/micromegas/MicromegasDefs.h` * `offline/packages/mvtx/CylinderGeom_Mvtx.cc` * `offline/packages/mvtx/CylinderGeom_Mvtx.h` * `offline/packages/mvtx/MvtxClusterPruner.cc` * `offline/packages/mvtx/MvtxClusterizer.cc` * `offline/packages/mvtx/MvtxHitPruner.cc` * `offline/packages/mvtx/SegmentationAlpide.cc` * `offline/packages/tpc/LaserClusterizer.cc` * `offline/packages/tpc/LaserEventIdentifier.cc` * `offline/packages/tpc/Tpc3DClusterizer.cc` * `offline/packages/tpc/TpcClusterMover.cc` * `offline/packages/tpc/TpcClusterMover.h` * `offline/packages/tpc/TpcClusterizer.cc` * `offline/packages/tpc/TpcCombinedRawDataUnpacker.cc` * `offline/packages/tpc/TpcCombinedRawDataUnpackerDebug.cc` * `offline/packages/tpc/TpcDistortionCorrection.cc` * `offline/packages/tpc/TpcLoadDistortionCorrection.cc` * `offline/packages/tpc/TpcRawDataTree.cc` * `offline/packages/tpc/TpcRawWriter.cc` * `offline/packages/tpc/TpcSimpleClusterizer.cc` * `offline/packages/tpc/TrainingHits.cc` * `offline/packages/trackbase/AlignmentTransformation.cc` * `offline/packages/trackbase/AlignmentTransformation.h` * `offline/packages/trackreco/DSTClusterPruning.cc` * `offline/packages/trackreco/DSTClusterPruning.h` * `offline/packages/trackreco/PHActsTrkFitter.cc` * `offline/packages/trackreco/PHActsTrkFitter.h` * `offline/packages/trackreco/PHSiliconTpcTrackMatching.cc` * `offline/packages/trackreco/PHSiliconTpcTrackMatching.h` * `offline/packages/trackreco/PHSimpleVertexFinder.h` * `offline/packages/trackreco/PHTpcDeltaZCorrection.h`
Author
|
Important Review skippedThis PR was authored by the user configured for CodeRabbit reviews. By default, CodeRabbit skips reviewing PRs authored by this user. It's recommended to use a dedicated user account to post CodeRabbit review feedback. To trigger a single review, invoke the You can disable this status message by setting the Comment |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docstrings generation was requested by @blackcathj.
The following files were modified:
generators/Herwig/HepMCTrigger/HepMCJetTrigger.ccgenerators/Herwig/HepMCTrigger/HepMCParticleTrigger.ccgenerators/Herwig/HepMCTrigger/HepMCParticleTrigger.hgenerators/PHPythia8/PHPythia8.ccgenerators/phhepmc/PHHepMCGenEventv1.ccoffline/QA/Calorimeters/CaloValid.ccoffline/QA/Tracking/MicromegasClusterQA.ccoffline/QA/Tracking/MicromegasClusterQA.hoffline/QA/Tracking/StateClusterResidualsQA.ccoffline/QA/Tracking/StateClusterResidualsQA.hoffline/framework/ffamodules/CDBInterface.ccoffline/framework/ffamodules/FlagHandler.hoffline/framework/ffamodules/HeadReco.ccoffline/framework/ffamodules/HeadReco.hoffline/framework/ffamodules/SyncReco.hoffline/framework/ffamodules/Timing.ccoffline/framework/ffamodules/Timing.hoffline/framework/fun4all/Fun4AllServer.ccoffline/framework/fun4all/Fun4AllServer.hoffline/framework/fun4all/InputFileHandler.ccoffline/framework/fun4all/InputFileHandler.hoffline/framework/fun4allraw/Fun4AllStreamingInputManager.ccoffline/framework/fun4allraw/SingleMicromegasPoolInput_v2.ccoffline/framework/fun4allraw/SingleMicromegasPoolInput_v2.hoffline/framework/fun4allraw/SingleMvtxPoolInput.ccoffline/framework/fun4allraw/SingleTriggeredInput.ccoffline/framework/fun4allraw/SingleTriggeredInput.hoffline/packages/CaloEmbedding/CombineTowerInfo.ccoffline/packages/CaloEmbedding/CombineTowerInfo.hoffline/packages/CaloEmbedding/CopyIODataNodes.ccoffline/packages/CaloEmbedding/CopyIODataNodes.hoffline/packages/CaloReco/PhotonClusterBuilder.ccoffline/packages/KFParticle_sPHENIX/KFParticle_sPHENIX.ccoffline/packages/PHGenFitPkg/PHGenFit/Fitter.ccoffline/packages/PHGenFitPkg/PHGenFit/Track.ccoffline/packages/Skimmers/Trigger/TriggerDSTSkimmer.ccoffline/packages/Skimmers/Trigger/TriggerDSTSkimmer.hoffline/packages/jetbackground/DetermineTowerBackground.ccoffline/packages/jetbackground/DetermineTowerBackground.hoffline/packages/mbd/MbdCalib.ccoffline/packages/mbd/MbdEvent.ccoffline/packages/mbd/MbdReco.ccoffline/packages/mbd/MbdSig.hoffline/packages/micromegas/MicromegasClusterizer.ccoffline/packages/micromegas/MicromegasCombinedDataDecoder.ccoffline/packages/micromegas/MicromegasCombinedDataDecoder.hoffline/packages/micromegas/MicromegasDefs.ccoffline/packages/micromegas/MicromegasDefs.hoffline/packages/mvtx/CylinderGeom_Mvtx.ccoffline/packages/mvtx/CylinderGeom_Mvtx.hoffline/packages/mvtx/MvtxClusterPruner.ccoffline/packages/mvtx/MvtxClusterizer.ccoffline/packages/mvtx/MvtxHitPruner.ccoffline/packages/mvtx/SegmentationAlpide.ccoffline/packages/tpc/LaserClusterizer.ccoffline/packages/tpc/LaserEventIdentifier.ccoffline/packages/tpc/Tpc3DClusterizer.ccoffline/packages/tpc/TpcClusterMover.ccoffline/packages/tpc/TpcClusterMover.hoffline/packages/tpc/TpcClusterizer.ccoffline/packages/tpc/TpcCombinedRawDataUnpacker.ccoffline/packages/tpc/TpcCombinedRawDataUnpackerDebug.ccoffline/packages/tpc/TpcDistortionCorrection.ccoffline/packages/tpc/TpcLoadDistortionCorrection.ccoffline/packages/tpc/TpcRawDataTree.ccoffline/packages/tpc/TpcRawWriter.ccoffline/packages/tpc/TpcSimpleClusterizer.ccoffline/packages/tpc/TrainingHits.ccoffline/packages/trackbase/AlignmentTransformation.ccoffline/packages/trackbase/AlignmentTransformation.hoffline/packages/trackreco/DSTClusterPruning.ccoffline/packages/trackreco/DSTClusterPruning.hoffline/packages/trackreco/PHActsTrkFitter.ccoffline/packages/trackreco/PHActsTrkFitter.hoffline/packages/trackreco/PHSiliconTpcTrackMatching.ccoffline/packages/trackreco/PHSiliconTpcTrackMatching.hoffline/packages/trackreco/PHSimpleVertexFinder.hoffline/packages/trackreco/PHTpcDeltaZCorrection.hThese file types are not supported
generators/Herwig/HepMCTrigger/Makefile.amoffline/QA/Tracking/Makefile.amoffline/framework/frog/CreateFileList.ploffline/packages/CaloEmbedding/Makefile.amoffline/packages/jetbackground/Makefile.amℹ️ Note