Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
andiwand committed Jul 14, 2024
1 parent 96ea89e commit ad1912c
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 1 deletion.
10 changes: 10 additions & 0 deletions Core/include/Acts/Propagator/Propagator.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ class BasePropagator {
using Options = PropagatorPlainOptions;

/// Method to propagate start bound track parameters to a target surface.
/// @param geoContext The geometry context.
/// @param magFieldContext The magnetic field context.
/// @param start The start bound track parameters.
/// @param target The target surface.
/// @param options The propagation options.
Expand Down Expand Up @@ -249,6 +251,8 @@ class Propagator final
/// @tparam propagator_options_t Type of the propagator options
/// @tparam path_aborter_t The path aborter type to be added
///
/// @param [in] geoContext The geometry context
/// @param [in] magFieldContext The magnetic field context
/// @param [in] start initial track parameters to propagate
/// @param [in] options Propagation options, type Options<,>
/// @param [in] makeCurvilinear Produce curvilinear parameters at the end of the propagation
Expand Down Expand Up @@ -278,6 +282,8 @@ class Propagator final
/// @tparam target_aborter_t The target aborter type to be added
/// @tparam path_aborter_t The path aborter type to be added
///
/// @param [in] geoContext The geometry context
/// @param [in] magFieldContext The magnetic field context
/// @param [in] start Initial track parameters to propagate
/// @param [in] target Target surface of to propagate to
/// @param [in] options Propagation options
Expand Down Expand Up @@ -306,6 +312,8 @@ class Propagator final
/// @tparam propagator_options_t Type of the propagator options
/// @tparam path_aborter_t The path aborter type to be added
///
/// @param [in] geoContext The geometry context
/// @param [in] magFieldContext The magnetic field context
/// @param [in] start Initial track parameters to propagate
/// @param [in] options Propagation options
///
Expand All @@ -329,6 +337,8 @@ class Propagator final
/// @tparam target_aborter_t The target aborter type to be added
/// @tparam path_aborter_t The path aborter type to be added
///
/// @param [in] geoContext The geometry context
/// @param [in] magFieldContext The magnetic field context
/// @param [in] start Initial track parameters to propagate
/// @param [in] target Target surface of to propagate to
/// @param [in] options Propagation options
Expand Down
1 change: 1 addition & 0 deletions Core/include/Acts/Propagator/PropagatorState.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ struct PropagatorState : private detail::Extendable<extension_state_t...> {
///
/// @tparam propagator_options_t the type of the propagator options
///
/// @param gctx The geometry context
/// @param topts The options handed over by the propagate call
/// @param steppingIn Stepper state instance to begin with
/// @param navigationIn Navigator state instance to begin with
Expand Down
10 changes: 9 additions & 1 deletion Core/include/Acts/Propagator/RiddersPropagator.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// This file is part of the Acts project.
//
// Copyright (C) 2017-2019 CERN for the benefit of the Acts project
// Copyright (C) 2017-2024 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
Expand Down Expand Up @@ -112,6 +112,8 @@ class RiddersPropagator {
/// @tparam parameters_t Type of the start parameters
/// @tparam propagator_options_t Type of the propagator options
///
/// @param [in] geoContext The geometry context
/// @param [in] magFieldContext The magnetic field context
/// @param [in] start Start parameters
/// @param [in] options Options of the propagations
///
Expand All @@ -130,6 +132,8 @@ class RiddersPropagator {
/// @tparam parameters_t Type of the start parameters
/// @tparam propagator_options_t Type of the propagator options
///
/// @param [in] geoContext The geometry context
/// @param [in] magFieldContext The magnetic field context
/// @param [in] start Start parameters
/// @param [in] target The target surface
/// @param [in] options Options of the propagations
Expand All @@ -150,6 +154,8 @@ class RiddersPropagator {
/// propagating again. This function is called from the different propagation
/// overloads in order to deduplicate code.
///
/// @param [in] geoContext The geometry context
/// @param [in] magFieldContext The magnetic field context
/// @param [in] options Options of the propagations
/// @param [in] start Start parameters
/// @param [in] nominalResult The result of the nominal propagation
Expand Down Expand Up @@ -180,6 +186,8 @@ class RiddersPropagator {
/// @tparam options_t PropagatorOptions object
/// @tparam parameters_t Type of the parameters to start the propagation with
///
/// @param [in] geoContext The geometry context
/// @param [in] magFieldContext The magnetic field context
/// @param [in] options Options do define how to wiggle
/// @param [in] start Start parameters which will be modified
/// @param [in] param Index to get the parameter that will be modified
Expand Down
2 changes: 2 additions & 0 deletions Core/include/Acts/TrackFitting/KalmanFitter.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -1246,6 +1246,8 @@ class KalmanFitter {
/// @tparam track_container_t Type of the track container backend
/// @tparam holder_t Type defining track container backend ownership
///
/// @param geoContext The geometry context
/// @param magField The magnetic field context
/// @param sParameters The initial track parameters
/// @param propagatorOptions The Propagator Options
/// @param trackContainer Input track container storage to append into
Expand Down
2 changes: 2 additions & 0 deletions Core/include/Acts/Utilities/TrackHelpers.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,8 @@ findTrackStateForExtrapolation(
/// @tparam propagator_t The propagator type
/// @tparam propagator_options_t The propagator options type
///
/// @param geoContext The geometry context
/// @param magFieldContext The magnetic field context
/// @param track The track which is modified in-place
/// @param referenceSurface The reference surface
/// @param propagator The propagator
Expand Down

0 comments on commit ad1912c

Please sign in to comment.