From a74bc534525162efbcd18be97bd52ff63100ea25 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Fillod=2C=20F8CFE?= Date: Mon, 5 Apr 2010 09:42:04 +0000 Subject: [PATCH] doxy: clarification about ctcss enabling/disabling git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@2864 7ae35d74-ebe9-4afe-98af-79ac388436b8 --- src/tones.c | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/tones.c b/src/tones.c index f2c5427cf..c3361a733 100644 --- a/src/tones.c +++ b/src/tones.c @@ -87,7 +87,10 @@ const tone_t full_dcs_list[] = { FULL_DCS_LIST }; * \note the \a tone integer is NOT in Hz, but in tenth of Hz! This way, * if you want to set a subaudible tone of 88.5 Hz for example, * then pass 885 to this function. - * Also, to disable Tone encoding, set \a tone to 0 (FIXME: not clear in API). + * + * NB: CTCSS encoding has to be explicitly enabled or disabled through + * a call to rig_set_func() with arg RIG_FUNC_TONE, unless it is + * unavailable and the \a tone arg has to be set to 0. * * \return RIG_OK if the operation has been sucessful, otherwise * a negative value if an error occured (in which case, cause is @@ -275,7 +278,10 @@ int HAMLIB_API rig_get_dcs_code(RIG *rig, vfo_t vfo, tone_t *code) * \note \a tone is NOT in Hz, but in tenth of Hz! This way, * if you want to set subaudible squelch tone of 88.5 Hz for example, * then pass 885 to this function. - * Also, to disable Tone squelch, set \a tone to 0 (FIXME: not clear in API). + * + * NB: the tone squelch has to be explicitly enabled or disabled through + * a call to rig_set_func() with arg RIG_FUNC_TSQL, unless it is + * unavailable and the \a tone arg has to be set to 0. * * \return RIG_OK if the operation has been sucessful, otherwise * a negative value if an error occured (in which case, cause is