Skip to content

Commit f805477

Browse files
headers: fix documentation comment (#206)
1 parent 48ee4de commit f805477

2 files changed

Lines changed: 4 additions & 5 deletions

File tree

SilKit/include/silkit/experimental/services/orchestration/TimeSyncDatatypesExtensions.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ namespace Services {
1212
namespace Orchestration {
1313

1414
/*! Callback type to indicate external simulation step coupling.
15-
* Cf., \ref AddOtherSimulationStepsCompletedHandler(ITimeSyncService*,TimeSyncOtherSimulationStepsCompletedHandler);
15+
* Cf., \ref AddOtherSimulationStepsCompletedHandler
1616
*/
1717
using OtherSimulationStepsCompletedHandler = std::function<void()>;
1818

SilKit/include/silkit/experimental/services/orchestration/TimeSyncServiceExtensions.hpp

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ namespace Experimental {
1515
namespace Services {
1616
namespace Orchestration {
1717

18-
/*! \brief Add a \ref SilKit::Experimental::Services::Orchestration::OtherSimulationStepsCompletedHandler on a given
18+
/*! \brief Add a \ref OtherSimulationStepsCompletedHandler on a given
1919
* time sync. service for external simulation step coupling.
2020
*
2121
* \param timeSyncService The time sync. service.
@@ -28,9 +28,8 @@ DETAIL_SILKIT_CPP_API auto AddOtherSimulationStepsCompletedHandler(
2828
SilKit::Experimental::Services::Orchestration::OtherSimulationStepsCompletedHandler handler)
2929
-> SilKit::Util::HandlerId;
3030

31-
/*! \brief Remove a LinSlaveConfigurationHandler by HandlerId on a given controller.
32-
*
33-
* Requires \ref Services::Lin::LinControllerMode::Master.
31+
/*! \brief Remove a \ref SilKit::Experimental::Services::Orchestration::OtherSimulationStepsCompletedHandler by
32+
* HandlerId on a given controller.
3433
*
3534
* \param timeSyncService The time sync. service.
3635
* \param handlerId Identifier of the callback to be removed. Obtained upon adding to respective handler.

0 commit comments

Comments
 (0)