mirrors/unleashed-firmware
1
Fork 0
mirror of https://github.com/DarkFlippers/unleashed-firmware.git synced 2025-12-12 04:34:43 +04:00
Code Issues Activity

lib: infrared: fixed doxygen declarations to match implementation (#4305)

Browse Source
This commit is contained in:
hedger
2025-11-06 16:40:18 +00:00
committed by GitHub
parent 6a5ae6cc0d
commit b54d63037b
2 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
lib/infrared/signal/infrared_brute_force.h
View File

@@ -55,11 +55,16 @@ void infrared_brute_force_set_db_filename(InfraredBruteForce* brute_force, const
InfraredErrorCode infrared_brute_force_calculate_messages(InfraredBruteForce* brute_force); 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,out] brute_force pointer to the instance to be started.
* @param[in] index index of the signal category in the dictionary. * @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( bool infrared_brute_force_start(
InfraredBruteForce* brute_force, InfraredBruteForce* brute_force,

2
lib/infrared/signal/infrared_signal.h
View File

@@ -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. * 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[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. * @returns InfraredErrorCodeNone if a signal body was successfully read, otherwise error code.
*/ */
InfraredErrorCode infrared_signal_read_body(InfraredSignal* signal, FlipperFormat* ff); InfraredErrorCode infrared_signal_read_body(InfraredSignal* signal, FlipperFormat* ff);