Skip to content

Commit

Permalink
Fix Doxygen member group formatting so member descriptions are not as…
Browse files Browse the repository at this point in the history
…sociated with group description (#1567)
  • Loading branch information
amandalund authored Jan 8, 2025
1 parent 7dbef97 commit b3d2514
Show file tree
Hide file tree
Showing 28 changed files with 70 additions and 7 deletions.
1 change: 1 addition & 0 deletions app/celer-g4/TimerOutput.hh
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ class TimerOutput final : public OutputInterface

//!@{
//! \name Output interface

//! Category of data to write
Category category() const final { return Category::result; }
//! Key for the entry inside the category.
Expand Down
1 change: 1 addition & 0 deletions src/accel/GeantSimpleCalo.hh
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ class GeantSimpleCalo final : public OutputInterface

//!@{
//! \name Output interface

//! Category of data to write
Category category() const final { return Category::result; }
// Key for the entry inside the category
Expand Down
1 change: 1 addition & 0 deletions src/accel/GeantStepDiagnostic.hh
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ class GeantStepDiagnostic final : public OutputInterface

//!@{
//! \name Output interface

//! Category of data to write
Category category() const final { return Category::result; }
//! Key for the entry inside the category.
Expand Down
8 changes: 8 additions & 0 deletions src/accel/SetupOptions.hh
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ struct SetupOptions

//!@{
//! \name I/O

//! GDML filename (optional: defaults to exporting existing Geant4)
std::string geometry_file;
//! Filename for JSON diagnostic output
Expand All @@ -143,6 +144,7 @@ struct SetupOptions

//!@{
//! \name Celeritas stepper options

//! Number of track "slots" to be transported simultaneously
size_type max_num_tracks{};
//! Maximum number of events in use (DEPRECATED: remove in v0.6)
Expand All @@ -161,6 +163,7 @@ struct SetupOptions

//!@{
//! \name Track reordering options

TrackOrder track_order{Device::num_devices() ? TrackOrder::init_charge
: TrackOrder::none};
//!@}
Expand All @@ -170,11 +173,13 @@ struct SetupOptions

//!@{
//! \name Stepping actions

AlongStepFactory make_along_step;
//!@}

//!@{
//! \name Field options

size_type max_field_substeps{100};
//!@}

Expand All @@ -183,12 +188,14 @@ struct SetupOptions

//!@{
//! \name Physics options

//! Do not use Celeritas physics for the given Geant4 process names
VecString ignore_processes;
//!@}

//!@{
//! \name CUDA options

//! Per-thread stack size (may be needed for VecGeom) [B]
size_type cuda_stack_size{};
//! Dynamic heap size (may be needed for VecGeom) [B]
Expand All @@ -201,6 +208,7 @@ struct SetupOptions

//!@{
//! \name Diagnostic setup

//! Filename base for slot diagnostics
std::string slot_diagnostic_prefix;
//!@}
Expand Down
2 changes: 2 additions & 0 deletions src/celeritas/ext/GeantOpticalPhysicsOptions.hh
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ struct GeantOpticalPhysicsOptions
{
//!@{
//! \name Optical photon creation physics

//! Cherenkov radiation options
CherenkovPhysicsOptions cherenkov;
//! Scintillation options
Expand All @@ -136,6 +137,7 @@ struct GeantOpticalPhysicsOptions

//!@{
//! \name Optical photon physics

//! Enable wavelength shifting and select a time profile
WLSTimeProfileSelection wavelength_shifting{WLSTimeProfileSelection::delta};
//! Enable second wavelength shifting type and select a time profile (TODO:
Expand Down
5 changes: 5 additions & 0 deletions src/celeritas/ext/GeantPhysicsOptions.hh
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ struct GeantPhysicsOptions

//!@{
//! \name Gamma physics

//! Enable Compton scattering
bool compton_scattering{true};
//! Enable the photoelectric effect
Expand All @@ -113,6 +114,7 @@ struct GeantPhysicsOptions

//!@{
//! \name Electron and positron physics

//! Enable discrete Coulomb
bool coulomb_scattering{false};
//! Enable e- and e+ ionization
Expand All @@ -132,6 +134,7 @@ struct GeantPhysicsOptions

//!@{
//! \name Physics options

//! Number of log-spaced bins per factor of 10 in energy
int em_bins_per_decade{7};
//! Enable universal energy fluctuations
Expand All @@ -144,6 +147,7 @@ struct GeantPhysicsOptions

//!@{
//! \name Cutoff options

//! Lowest energy of any EM physics process
MevEnergy min_energy{0.1 * 1e-3}; // 0.1 keV
//! Highest energy of any EM physics process
Expand All @@ -160,6 +164,7 @@ struct GeantPhysicsOptions

//!@{
//! \name Multiple scattering configuration

//! E-/e+ range factor for MSC models
double msc_range_factor{0.04};
//! Safety factor for MSC models
Expand Down
1 change: 1 addition & 0 deletions src/celeritas/global/KernelContextException.hh
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ class KernelContextException : public RichContextException

//!@{
//! \name Track accessors

//! Kernel thread ID
ThreadId thread() const { return thread_; }
//! Track slot ID
Expand Down
2 changes: 1 addition & 1 deletion src/celeritas/io/ImportElement.hh
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ struct ImportIsotope
struct ImportElement
{
//!@{
//! \name type aliases
//! \name Type aliases
using IsotopeIndex = unsigned int;
using IsotopeFrac = std::pair<IsotopeIndex, double>;
using VecIsotopeFrac = std::vector<IsotopeFrac>;
Expand Down
3 changes: 3 additions & 0 deletions src/celeritas/mat/MaterialParams.hh
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ class MaterialParams final : public ParamsDataInterface<MaterialParamsData>

//!@{
//! \name Material metadata

//! Number of materials
MaterialId::size_type num_materials() const { return mat_labels_.size(); }

Expand All @@ -127,6 +128,7 @@ class MaterialParams final : public ParamsDataInterface<MaterialParamsData>

//!@{
//! \name Element metadata

//! Number of distinct elements definitions
ElementId::size_type num_elements() const { return el_labels_.size(); }

Expand All @@ -142,6 +144,7 @@ class MaterialParams final : public ParamsDataInterface<MaterialParamsData>

//!@{
//! \name Isotope metadata

//! Number of distinct isotope definitions
IsotopeId::size_type num_isotopes() const { return isot_labels_.size(); }

Expand Down
1 change: 1 addition & 0 deletions src/celeritas/optical/CoreParams.hh
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ class CoreParams final : public ParamsDataInterface<CoreParamsData>

//!@{
//! \name Data interface

//! Access data on the host
HostRef const& host_ref() const final { return host_ref_; }
//! Access data on the device
Expand Down
2 changes: 2 additions & 0 deletions src/celeritas/optical/detail/OffloadParams.hh
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ class OffloadParams final : public AuxParamsInterface,

//!@{
//! \name Aux interface

//! Short name for the action
std::string_view label() const final { return "optical-offload"; }
//! Index of this class instance in its registry
Expand All @@ -40,6 +41,7 @@ class OffloadParams final : public AuxParamsInterface,

//!@{
//! \name Data interface

//! Access data on host
HostRef const& host_ref() const final { return data_.host_ref(); }
//! Access data on device
Expand Down
3 changes: 3 additions & 0 deletions src/celeritas/optical/detail/OpticalLaunchAction.hh
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ class OpticalLaunchAction : public AuxParamsInterface,

//!@{
//! \name Aux/action metadata interface

//! Short name for the action
std::string_view label() const final { return "optical-offload-launch"; }
// Name of the action (for user output)
Expand All @@ -86,6 +87,7 @@ class OpticalLaunchAction : public AuxParamsInterface,

//!@{
//! \name Aux interface

//! Index of this class instance in its registry
AuxId aux_id() const final { return aux_id_; }
// Build optical core state data for a stream
Expand All @@ -94,6 +96,7 @@ class OpticalLaunchAction : public AuxParamsInterface,

//!@{
//! \name Action interface

//! ID of the model
ActionId action_id() const final { return action_id_; }
//! Dependency ordering of the action
Expand Down
3 changes: 3 additions & 0 deletions src/celeritas/track/ExtendFromPrimariesAction.hh
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ class ExtendFromPrimariesAction final : public CoreStepActionInterface,

//!@{
//! \name Metadata interface

//! Label for the auxiliary data and action
std::string_view label() const final { return sad_.label(); }
// Description of the action
Expand All @@ -61,6 +62,7 @@ class ExtendFromPrimariesAction final : public CoreStepActionInterface,

//!@{
//! \name Step action interface

//! ID of the action
ActionId action_id() const final { return sad_.action_id(); }
//! Dependency ordering of the action
Expand All @@ -73,6 +75,7 @@ class ExtendFromPrimariesAction final : public CoreStepActionInterface,

//!@{
//! \name Aux params interface

//! Index of this class instance in its registry
AuxId aux_id() const final { return aux_id_; }
// Build state data for a stream
Expand Down
3 changes: 3 additions & 0 deletions src/celeritas/track/ExtendFromSecondariesAction.hh
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ class ExtendFromSecondariesAction final : public CoreStepActionInterface,

//!@{
//! \name Action interface

//! ID of the action
ActionId action_id() const final { return id_; }
//! Short name for the action
Expand All @@ -88,6 +89,7 @@ class ExtendFromSecondariesAction final : public CoreStepActionInterface,

//!@{
//! \name ExplicitAction interface

// Launch kernel with host data
void step(CoreParams const&, CoreStateHost&) const final;
// Launch kernel with device data
Expand All @@ -96,6 +98,7 @@ class ExtendFromSecondariesAction final : public CoreStepActionInterface,

//!@{
//! \name BeginRunAction interface

// No action necessary for host data
void begin_run(CoreParams const&, CoreStateHost&) final {}
// Warm up asynchronous allocation at beginning of run
Expand Down
4 changes: 4 additions & 0 deletions src/celeritas/track/StatusChecker.hh
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ class StatusChecker final : public AuxParamsInterface,

//!@{
//! \name Aux/action metadata interface

//! Label for the auxiliary data and action
std::string_view label() const final { return "status-check"; }
// Description of the action
Expand All @@ -54,6 +55,7 @@ class StatusChecker final : public AuxParamsInterface,

//!@{
//! \name Aux params interface

//! Index of this class instance in its registry
AuxId aux_id() const final { return aux_id_; }
// Build state data for a stream
Expand All @@ -62,6 +64,7 @@ class StatusChecker final : public AuxParamsInterface,

//!@{
//! \name Begin run interface

//! Index of this class instance in its registry
ActionId action_id() const final { return action_id_; }
// Set host data at the beginning of a run
Expand All @@ -72,6 +75,7 @@ class StatusChecker final : public AuxParamsInterface,

//!@{
//! \name Data interface

//! Access data on host
HostRef const& host_ref() const final { return data_.host_ref(); }
//! Access data on device
Expand Down
4 changes: 4 additions & 0 deletions src/celeritas/user/ActionDiagnostic.hh
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ class ActionDiagnostic final : public CoreStepActionInterface,

//!@{
//! \name Action interface

//! ID of the action
ActionId action_id() const final { return id_; }
//! Short name for the action
Expand All @@ -78,6 +79,7 @@ class ActionDiagnostic final : public CoreStepActionInterface,

//!@{
//! \name BeginRunAction interface

// Set host data at the beginning of a run
void begin_run(CoreParams const&, CoreStateHost&) final;
// Set device data at the beginning of a run
Expand All @@ -86,6 +88,7 @@ class ActionDiagnostic final : public CoreStepActionInterface,

//!@{
//! \name ExplicitAction interface

// Launch kernel with host data
void step(CoreParams const&, CoreStateHost&) const final;
// Launch kernel with device data
Expand All @@ -94,6 +97,7 @@ class ActionDiagnostic final : public CoreStepActionInterface,

//!@{
//! \name Output interface

//! Category of data to write
Category category() const final { return Category::result; }
// Write output to the given JSON object
Expand Down
2 changes: 2 additions & 0 deletions src/celeritas/user/SimpleCalo.hh
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ class SimpleCalo final : public StepInterface, public OutputInterface

//!@{
//! \name Step interface

// Map volume names to detector IDs and exclude tracks with no deposition
Filters filters() const final;
// Save energy deposition and pre-step volume
Expand All @@ -73,6 +74,7 @@ class SimpleCalo final : public StepInterface, public OutputInterface

//!@{
//! \name Output interface

// Category of data to write
Category category() const final { return Category::result; }
// Key for the entry inside the category.
Expand Down
3 changes: 3 additions & 0 deletions src/celeritas/user/SlotDiagnostic.hh
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ class SlotDiagnostic final : public CoreStepActionInterface,

//!@{
//! \name Metadata interface

//! Label for the auxiliary data and action
std::string_view label() const final { return sad_.label(); }
// Description of the action
Expand All @@ -72,6 +73,7 @@ class SlotDiagnostic final : public CoreStepActionInterface,

//!@{
//! \name Step action interface

//! Index of this class instance in its registry
ActionId action_id() const final { return sad_.action_id(); }
//! Index of this class instance in its registry
Expand All @@ -84,6 +86,7 @@ class SlotDiagnostic final : public CoreStepActionInterface,

//!@{
//! \name Aux params interface

//! Index of this class instance in its registry
AuxId aux_id() const final { return aux_id_; }
// Build state data for a stream
Expand Down
2 changes: 2 additions & 0 deletions src/celeritas/user/StepDiagnostic.hh
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ class StepDiagnostic final : public CoreStepActionInterface,

//!@{
//! \name ExplicitAction interface

// Launch kernel with host data
void step(CoreParams const&, CoreStateHost&) const final;
// Launch kernel with device data
Expand All @@ -71,6 +72,7 @@ class StepDiagnostic final : public CoreStepActionInterface,

//!@{
//! \name Output interface

//! Category of data to write
Category category() const final { return Category::result; }
// Write output to the given JSON object
Expand Down
Loading

0 comments on commit b3d2514

Please sign in to comment.