mirror
/
Hamlib
kopia lustrzana https://github.com/Hamlib/Hamlib
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

Fix Doxygen in rig.c. Commit c5c60f0 also touched Doxygen comments which 

was not intended. It replaced \return with \RETURNFUNC. Breaking
Doxygen.
pull/793/head
Wouter van Gulik 2021-09-08 22:45:36 +02:00
rodzic 3e1b06432b
commit 998e19bdd4
1 zmienionych plików z 50 dodań i 50 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

100
src/rig.c
Wyświetl plik

@ -663,7 +663,7 @@ RIG *HAMLIB_API rig_init(rig_model_t rig_model)
* Opens communication to a radio which \a RIG handle has been passed
* by argument.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -1110,7 +1110,7 @@ int HAMLIB_API rig_open(RIG *rig)
* Closes communication to a radio which \a RIG handle has been passed
* by argument that was previously open with rig_open().
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -1288,7 +1288,7 @@ int HAMLIB_API rig_close(RIG *rig)
* Releases a rig struct which port has eventually been closed already
* with rig_close().
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -1332,7 +1332,7 @@ int HAMLIB_API rig_cleanup(RIG *rig)
* timeout seconds to stop rigctld when VFO is manually changed
* turns on/off the radio.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -1357,7 +1357,7 @@ int HAMLIB_API rig_set_twiddle(RIG *rig, int seconds)
* \param rig The rig handle
* \param seconds 1=Ignore Sub, 2=Ignore Main
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -1383,7 +1383,7 @@ int HAMLIB_API rig_set_uplink(RIG *rig, int val)
* \param rig The rig handle
* \param seconds The timeout value
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -1764,7 +1764,7 @@ int twiddling(RIG *rig)
*
* Sets the frequency of the target VFO.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -1965,7 +1965,7 @@ int HAMLIB_API rig_set_freq(RIG *rig, vfo_t vfo, freq_t freq)
* The value stored at \a freq location equals RIG_FREQ_NONE when the current
* frequency of the VFO is not defined (e.g. blank memory).
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -2183,7 +2183,7 @@ int HAMLIB_API rig_get_freq(RIG *rig, vfo_t vfo, freq_t *freq)
* The value stored at \a freq location equals RIG_FREQ_NONE when the current
* frequency of the VFO is not defined (e.g. blank memory).
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -2211,7 +2211,7 @@ int HAMLIB_API rig_get_freqs(RIG *rig, freq_t *freqA, freq_t freqB)
* unchanged from the current value or default for the mode determined
* by the rig.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -2310,7 +2310,7 @@ int HAMLIB_API rig_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width)
* Note that if either \a mode or \a width is NULL, -RIG_EINVAL is returned.
* Both must be given even if only one is actually wanted.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -2596,7 +2596,7 @@ pbwidth_t HAMLIB_API rig_passband_wide(RIG *rig, rmode_t mode)
* for VFOA, VFOB, VFOC respectively or RIG_VFO_MEM for Memory mode.
* Supported VFOs depends on rig capabilities.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -2738,7 +2738,7 @@ int HAMLIB_API rig_set_vfo(RIG *rig, vfo_t vfo)
* for VFOA, VFOB, VFOC respectively or RIG_VFO_MEM for Memory mode.
* Supported VFOs depends on rig capabilities.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -2818,7 +2818,7 @@ int HAMLIB_API rig_get_vfo(RIG *rig, vfo_t *vfo)
*
* Sets "Push-To-Talk" on/off.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -3103,7 +3103,7 @@ int HAMLIB_API rig_set_ptt(RIG *rig, vfo_t vfo, ptt_t ptt)
*
* Retrieves the status of PTT (are we on the air?).
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -3375,7 +3375,7 @@ int HAMLIB_API rig_get_ptt(RIG *rig, vfo_t vfo, ptt_t *ptt)
*
* Retrieves the status of DCD (is squelch open?).
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -3489,7 +3489,7 @@ int HAMLIB_API rig_get_dcd(RIG *rig, vfo_t vfo, dcd_t *dcd)
*
* Sets the current repeater shift.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -3560,7 +3560,7 @@ int HAMLIB_API rig_set_rptr_shift(RIG *rig, vfo_t vfo, rptr_shift_t rptr_shift)
*
* Retrieves the current repeater shift.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -3636,7 +3636,7 @@ int HAMLIB_API rig_get_rptr_shift(RIG *rig, vfo_t vfo, rptr_shift_t *rptr_shift)
*
* Sets the current repeater offset.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -3706,7 +3706,7 @@ int HAMLIB_API rig_set_rptr_offs(RIG *rig, vfo_t vfo, shortfreq_t rptr_offs)
*
* Retrieves the current repeater offset.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -3781,7 +3781,7 @@ int HAMLIB_API rig_get_rptr_offs(RIG *rig, vfo_t vfo, shortfreq_t *rptr_offs)
*
* Sets the split(TX) frequency.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -3932,7 +3932,7 @@ int HAMLIB_API rig_set_split_freq(RIG *rig, vfo_t vfo, freq_t tx_freq)
*
* Retrieves the current split(TX) frequency.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -4081,7 +4081,7 @@ int HAMLIB_API rig_get_split_freq(RIG *rig, vfo_t vfo, freq_t *tx_freq)
*
* Sets the split(TX) mode.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -4211,7 +4211,7 @@ int HAMLIB_API rig_set_split_mode(RIG *rig,
* The value stored at \a tx_mode location equals RIG_MODE_NONE
* when the current mode of the VFO is not defined (e.g. blank memory).
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -4345,7 +4345,7 @@ int HAMLIB_API rig_get_split_mode(RIG *rig, vfo_t vfo, rmode_t *tx_mode,
* the rig VFOs have to be exchanged or swapped to complete this
* combined function.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -4460,7 +4460,7 @@ int HAMLIB_API rig_set_split_freq_mode(RIG *rig,
* the rig VFOs have to be exchanged or swapped to complete this
* combined function.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -4518,7 +4518,7 @@ int HAMLIB_API rig_get_split_freq_mode(RIG *rig,
*
* Sets the current split mode.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -4643,7 +4643,7 @@ int HAMLIB_API rig_set_split_vfo(RIG *rig,
*
* Retrieves the current split mode.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -4775,7 +4775,7 @@ int HAMLIB_API rig_get_split_vfo(RIG *rig,
*
* Sets the current RIT offset. A value of 0 for \a rit disables RIT.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -4846,7 +4846,7 @@ int HAMLIB_API rig_set_rit(RIG *rig, vfo_t vfo, shortfreq_t rit)
*
* Retrieves the current RIT offset.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -4923,7 +4923,7 @@ int HAMLIB_API rig_get_rit(RIG *rig, vfo_t vfo, shortfreq_t *rit)
*
* Sets the current XIT offset. A value of 0 for \a xit disables XIT.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -4994,7 +4994,7 @@ int HAMLIB_API rig_set_xit(RIG *rig, vfo_t vfo, shortfreq_t xit)
*
* Retrieves the current XIT offset.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -5071,7 +5071,7 @@ int HAMLIB_API rig_get_xit(RIG *rig, vfo_t vfo, shortfreq_t *xit)
*
* Sets the Tuning Step.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -5142,7 +5142,7 @@ int HAMLIB_API rig_set_ts(RIG *rig, vfo_t vfo, shortfreq_t ts)
*
* Retrieves the current tuning step.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -5223,7 +5223,7 @@ int HAMLIB_API rig_get_ts(RIG *rig, vfo_t vfo, shortfreq_t *ts)
rig_set_ant(rig, RIG_VFO_RX, RIG_ANT_2);
\endcode
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -5394,7 +5394,7 @@ int HAMLIB_API rig_get_ant(RIG *rig, vfo_t vfo, ant_t ant, value_t *option,
* also provided since the relative power is peculiar to a specific
* freq and mode range of the radio.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -5450,7 +5450,7 @@ int HAMLIB_API rig_power2mW(RIG *rig,
* also provided since the relative power is peculiar to a specific
* freq and mode range of the radio.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -5547,7 +5547,7 @@ shortfreq_t HAMLIB_API rig_get_resolution(RIG *rig, rmode_t mode)
* See #RIG_POWER_ON, #RIG_POWER_OFF and #RIG_POWER_STANDBY defines
* for the \a status.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, ortherwise
* \return RIG_OK if the operation has been successful, ortherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -5584,7 +5584,7 @@ int HAMLIB_API rig_set_powerstat(RIG *rig, powerstat_t status)
* Retrieve the status of the radio. See RIG_POWER_ON, RIG_POWER_OFF and
* RIG_POWER_STANDBY defines for the \a status.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -5626,7 +5626,7 @@ int HAMLIB_API rig_get_powerstat(RIG *rig, powerstat_t *status)
* See RIG_RESET_NONE, RIG_RESET_SOFT and RIG_RESET_MCALL defines
* for the \a reset.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -5701,7 +5701,7 @@ rig_model_t HAMLIB_API rig_probe(hamlib_port_t *port)
* \warning this is really Experimental, It has been tested only
* with IC-706MkIIG. any feedback welcome! --SF
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*/
@ -5761,7 +5761,7 @@ vfo_op_t HAMLIB_API rig_has_vfo_op(RIG *rig, vfo_op_t op)
* Performs Memory/VFO operation.
* See #vfo_op_t for more information.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -5865,7 +5865,7 @@ scan_t HAMLIB_API rig_has_scan(RIG *rig, scan_t scan)
* Performs scanning operation.
* See #scan_t for more information.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -5937,7 +5937,7 @@ int HAMLIB_API rig_scan(RIG *rig, vfo_t vfo, scan_t scan, int ch)
* Sends DTMF digits.
* See DTMF change speed, etc. (TODO).
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -6013,7 +6013,7 @@ int HAMLIB_API rig_send_dtmf(RIG *rig, vfo_t vfo, const char *digits)
* Receives DTMF digits (not blocking).
* See DTMF change speed, etc. (TODO).
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -6088,7 +6088,7 @@ int HAMLIB_API rig_recv_dtmf(RIG *rig, vfo_t vfo, char *digits, int *length)
* Sends morse message.
* See keyer change speed, etc. (TODO).
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -6160,7 +6160,7 @@ int HAMLIB_API rig_send_morse(RIG *rig, vfo_t vfo, const char *msg)
*
* Stops the send morse message.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -6258,7 +6258,7 @@ static int wait_morse_ptt(RIG *rig, vfo_t vfo)
*
* waits for the end of the morse message to be sent.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -6315,7 +6315,7 @@ int HAMLIB_API rig_wait_morse(RIG *rig, vfo_t vfo)
*
* Sends voice memory content.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).
*
@ -6599,7 +6599,7 @@ int HAMLIB_API rig_get_rig_info(RIG *rig, char *response, int max_response_len)
* for VFOA, VFOB, VFOC respectively or RIG_VFO_MEM for Memory mode.
* Supported VFOs depends on rig capabilities.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* \return RIG_OK if the operation has been successful, otherwise
* a negative value if an error occurred (in which case use rigerror(return)
* for error message).
*