Standardize Doxygen documentation (#6885)

This commit is contained in:
DawnFire42 2026-05-21 16:58:07 -04:00 committed by GitHub
parent 03d54265fe
commit 33e0f8699b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
306 changed files with 539 additions and 487 deletions

View file

@ -2,8 +2,8 @@
* @file replay_manager.h
* @ingroup Core
* @ingroup Replay
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef REPLAY_MANAGER_H
#define REPLAY_MANAGER_H

View file

@ -103,8 +103,12 @@ void ReplayTimelineWidget::skipToTime(int newTime, bool doRewindBuffering)
update();
}
/// @param doRewindBuffering When true, if multiple backward skips are made in quick succession, only a single rewind
/// is processed at the end. When false, the backwards skip will always cause an immediate rewind
/**
* @brief Handles a backwards skip in the replay timeline.
*
* @param doRewindBuffering When true, if multiple backward skips are made in quick succession, only a single rewind
* is processed at the end. When false, the backwards skip will always cause an immediate rewind.
*/
void ReplayTimelineWidget::handleBackwardsSkip(bool doRewindBuffering)
{
if (doRewindBuffering) {
@ -151,7 +155,7 @@ void ReplayTimelineWidget::replayTimerTimeout()
}
}
/// Processes all unprocessed events up to the current time.
/** @brief Processes all unprocessed events up to the current time. */
void ReplayTimelineWidget::processNewEvents(PlaybackMode playbackMode)
{
currentProcessedTime = currentVisualTime;

View file

@ -1,8 +1,8 @@
/**
* @file replay_timeline_widget.h
* @ingroup Replay
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef REPLAY_TIMELINE_WIDGET
#define REPLAY_TIMELINE_WIDGET