Skip to content

v2.4.2 - Fix @file Docstrings in v2_* Files (2026-02-24)

What Changed?

This release fixes @file docstrings in all v2_* source and header files. The docstrings had stale names from before the v2_ prefix was added (e.g., main_next.cpp, command.h). All @file tags now match their actual filenames.


What's New

Main Feature: Correct @file Docstrings Across v2_* Files

What it does:

Updates the @file Doxygen tag in 15 files so each matches its actual filename:

File Before After
src/v2_main.cpp main_next.cpp v2_main.cpp
src/v2_command.cpp command.cpp v2_command.cpp
src/v2_command_manager.cpp command_manager.cpp v2_command_manager.cpp
src/v2_command_queue.cpp command_queue.cpp v2_command_queue.cpp
src/v2_device_response.cpp device_response.cpp v2_device_response.cpp
src/v2_detection_processor.cpp detection_processor.cpp v2_detection_processor.cpp
src/v2_event_queue.cpp event_queue.cpp v2_event_queue.cpp
include/v2_command.h command.h v2_command.h
include/v2_command_manager.h command_manager.h v2_command_manager.h
include/v2_command_queue.h command_queue.h v2_command_queue.h
include/v2_detector.h detector.h v2_detector.h
include/v2_detection_processor.h detection_processor.h v2_detection_processor.h
include/v2_device_response.h device_response.h v2_device_response.h
include/v2_device_response_types.h device_response_types.h v2_device_response_types.h
include/v2_event_queue.h event_queue.h v2_event_queue.h

Why it matters:

  • Doxygen generates documentation using @file as the page title and cross-reference key
  • Stale names cause mismatches between generated docs and actual source files
  • main_next.cpp was the old working filename during initial v2 development

Installation

Quick Start

# Get the release
git checkout 2.4.2

# Build
task v2:build

# Upload
task v2:upload

# Check it works
task monitor

What's Different from the Last Version?

🔧 Changed

  • 15 files: @file docstring updated to match actual filename

Is It Safe to Upgrade?

Backward Compatible: Yes

  • Documentation-only change; no behavior or API changes

Tests Passed

  • ✅ Builds without errors

Release Details

  • Date: 2026-02-24
  • Version: v2.4.2
  • Files Changed: 15 (docstrings only)

Next Steps

Continued code quality improvements (see REFACTORING_ROADMAP.md):

  • Propagate set_rtc_time() error return value (P2)
  • Remove double discard_input() call (P2)
  • Add V2_ prefix to include guards (P2)