From d1169d40ade1a8a03e5a1459c28c8cd656545efb Mon Sep 17 00:00:00 2001 From: Tommaso Pecorella Date: Sun, 24 Oct 2021 17:14:32 +0200 Subject: [PATCH] core: fix some doxygen warnings --- src/core/model/realtime-simulator-impl.h | 15 ++++++++++++--- src/core/model/simulator.h | 1 - 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/src/core/model/realtime-simulator-impl.h b/src/core/model/realtime-simulator-impl.h index 269693be4..962fa603a 100644 --- a/src/core/model/realtime-simulator-impl.h +++ b/src/core/model/realtime-simulator-impl.h @@ -112,16 +112,25 @@ public: /** \copydoc ScheduleWithContext(uint32_t,const Time&,EventImpl*) */ void ScheduleRealtimeWithContext (uint32_t context, const Time &delay, EventImpl *event); - /** \copydoc Schedule(const Time&,EventImpl*) */ + /** + * Schedule a future event execution (in the same context). + * + * @param [in] delay Delay until the event expires. + * @param [in] event The event to schedule. + */ void ScheduleRealtime (const Time &delay, EventImpl *event); /** - * \copybrief ScheduleNow(EventImpl*) + * Schedule an event to run at the current virtual time. * * \param [in] context Event context. * \param [in] event The event to schedule. */ void ScheduleRealtimeNowWithContext (uint32_t context, EventImpl *event); - /** \copydoc ScheduleNow(EventImpl*) */ + /** + * Schedule an event to run at the current virtual time. + * + * @param [in] event The event to schedule. + */ void ScheduleRealtimeNow (EventImpl *event); /** * Get the current real time from the synchronizer. diff --git a/src/core/model/simulator.h b/src/core/model/simulator.h index 9d9dd2ad3..82fdcd86e 100644 --- a/src/core/model/simulator.h +++ b/src/core/model/simulator.h @@ -464,7 +464,6 @@ public: * @param [in] delay Delay until the event expires. * @param [in] context Event context. * @param [in] event The event to schedule. - * @returns A unique identifier for the newly-scheduled event. */ static void ScheduleWithContext (uint32_t context, const Time &delay, EventImpl *event);