From b54d63037b1764268cf16191d79dadc9e4fcd089 Mon Sep 17 00:00:00 2001 From: hedger Date: Thu, 6 Nov 2025 16:40:18 +0000 Subject: [PATCH] lib: infrared: fixed doxygen declarations to match implementation (#4305) --- lib/infrared/signal/infrared_brute_force.h | 9 +++++++-- lib/infrared/signal/infrared_signal.h | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/lib/infrared/signal/infrared_brute_force.h b/lib/infrared/signal/infrared_brute_force.h index f6e31af98..b48d04533 100644 --- a/lib/infrared/signal/infrared_brute_force.h +++ b/lib/infrared/signal/infrared_brute_force.h @@ -55,11 +55,16 @@ void infrared_brute_force_set_db_filename(InfraredBruteForce* brute_force, const InfraredErrorCode infrared_brute_force_calculate_messages(InfraredBruteForce* brute_force); /** - * @brief Start transmitting signals from a category stored in an InfraredBruteForce's instance dictionary. + * @brief Start transmitting signals from a category stored in the dictionary. + * + * The function locates the category identified by @p index, reports the number of + * records it contains via @p record_count, and prepares the brute-force instance + * to transmit those signals. On failure @p record_count is set to zero. * * @param[in,out] brute_force pointer to the instance to be started. * @param[in] index index of the signal category in the dictionary. - * @returns true on success, false otherwise. + * @param[out] record_count pointer that receives the number of records in the category. + * @returns true if the category is found and the backing database file is opened, false otherwise. */ bool infrared_brute_force_start( InfraredBruteForce* brute_force, diff --git a/lib/infrared/signal/infrared_signal.h b/lib/infrared/signal/infrared_signal.h index 96afd8c2e..93f1f88fe 100644 --- a/lib/infrared/signal/infrared_signal.h +++ b/lib/infrared/signal/infrared_signal.h @@ -163,7 +163,7 @@ InfraredErrorCode infrared_signal_read_name(FlipperFormat* ff, FuriString* name) * Same behaviour as infrared_signal_read(), but only the body is read. * * @param[in,out] ff pointer to the FlipperFormat file instance to read from. - * @param[out] body pointer to the InfraredSignal instance to hold the signal body. Must be properly allocated. + * @param[out] signal pointer to the InfraredSignal instance to hold the signal body. Must be properly allocated. * @returns InfraredErrorCodeNone if a signal body was successfully read, otherwise error code. */ InfraredErrorCode infrared_signal_read_body(InfraredSignal* signal, FlipperFormat* ff);