mwalbeck/rtl_433
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

minor: Fix Doxygen warnings (closes )

Browse source
This commit is contained in:
Christian W. Zuckschwerdt 2024-02-07 17:23:22 +01:00
parent 06b03b7a6e
commit fe8ca7ee0d
13 changed files with 121 additions and 117 deletions

1
include/baseband.h
View file

@ -122,6 +122,7 @@ void baseband_low_pass_filter(uint16_t const *x_buf, int16_t *y_buf, uint32_t le
@param x_buf input samples (I/Q samples in interleaved uint8)
@param[out] y_buf output from FM demodulator
@param num_samples number of samples to process
@param samp_rate sample rate of samples to process
@param low_pass Low-pass filter frequency or ratio
@param[in,out] state State to store between chunk processing
*/

1
include/output_file.h
View file

@ -17,6 +17,7 @@
/** Construct data output for CSV printer.
@param log_level the highest log level to process
@param file the output stream
@return The auxiliary data to pass along with data_csv_printer to data_print.
You must release this object with data_output_free once you're done with it.

1
include/output_log.h
View file

@ -17,6 +17,7 @@
/** Construct data output for LOG printer.
@param log_level the highest log level to process
@param file the optional output stream, defaults to stderr
@return The auxiliary data to pass along with data_log_printer to data_print.
You must release this object with data_output_free once you're done with it.

1
include/output_rtltcp.h
View file

@ -22,6 +22,7 @@ struct r_cfg;
@param host the server host to bind
@param port the server port to bind
@param opts additional options, currently "control" enables write access
@param cfg the r_api config to use
@return The initialized rtltcp output instance.
You must release this object with raw_output_free once you're done with it.

2
src/devices/fineoffset_wh31l.c
View file

@ -2,7 +2,7 @@
Ambient Weather (Fine Offset) WH31L protocol.
Copyright (C) 2021 Christian W. Zuckschwerdt <zany@triq.net>
based on protocol analysis by @MksRasp.
based on protocol analysis by \@MksRasp.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by

2
src/devices/fineoffset_wh45.c
View file

@ -1,7 +1,7 @@
/** @file
Fine Offset Electronics WH45 air quality sensor.
Copyright (C) 2022 @anthyz
Copyright (C) 2022 \@anthyz
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by

2
src/devices/fineoffset_wh55.c
View file

@ -2,7 +2,7 @@
Fine Offset / Ecowitt WH55 water leak sensor.
Copyright (C) 2023 Christian W. Zuckschwerdt <zany@triq.net>
Protocol analysis by @cdavis289, test data by @AhrBee
Protocol analysis by \@cdavis289, test data by \@AhrBee
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by

2
src/devices/fineoffset_wn34.c
View file

@ -1,7 +1,7 @@
/** @file
Fine Offset Electronics WN34 Temperature Sensor.
Copyright (C) 2022 @anthyz
Copyright (C) 2022 \@anthyz
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by

2
src/devices/fineoffset_ws80.c
View file

@ -2,7 +2,7 @@
Fine Offset Electronics WS80 weather station.
Copyright (C) 2022 Christian W. Zuckschwerdt <zany@triq.net>
Protocol description by @davidefa
Protocol description by \@davidefa
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by

2
src/devices/fineoffset_ws90.c
View file

@ -2,7 +2,7 @@
Fine Offset Electronics WS90 weather station.
Copyright (C) 2022 Christian W. Zuckschwerdt <zany@triq.net>
Protocol description by @davidefa
Protocol description by \@davidefa
Copy of fineoffset_ws80.c with changes made to support Fine Offset WS90
sensor array. Changes made by John Pochmara <john@zoiedog.com>

2
src/devices/rubicson_pool_48942.c
View file

@ -30,7 +30,7 @@ Sync pulses:
730 730 730 730 730 730 730 730 [us]
The device's transmission interval depends on the configured
channel. The interval is 55 + <device channel> seconds.
channel. The interval is 55 + `device channel` seconds.
Data format:
71 ba 4e 60 ba 0

4
src/devices/srsmith_pool_srs_2c_tx.c
View file

@ -1,5 +1,5 @@
/** @file
SRSmith Pool Light Remote Control, Model #SRS-2C-TX.
SRSmith Pool Light Remote Control, Model SRS-2C-TX.
Copyright (C) 2022 gcohen55
@ -12,7 +12,7 @@
#include "decoder.h"
/**
SRSmith Pool Light Remote Control, Model #SRS-2C-TX.
SRSmith Pool Light Remote Control, Model SRS-2C-TX.
The SR Smith remote control sends broadcasts of ~144 bits and it comes in shifted (similar to the Maverick XR30 BBQ Sensor)
- Frequency: 915MHz