Skip to content

Commit

Permalink
Update Doxygen comments in
Browse files Browse the repository at this point in the history
amp_settings.c
amplifier.c
rot_settings.c
  • Loading branch information
N0NB committed Apr 7, 2021
1 parent 74654e1 commit 716866b
Show file tree
Hide file tree
Showing 3 changed files with 315 additions and 190 deletions.
18 changes: 11 additions & 7 deletions src/amp_settings.c
Original file line number Diff line number Diff line change
Expand Up @@ -50,19 +50,23 @@


/**
* \brief Check retrieval ability of level settings.
* \brief Check which level settings can be queried.
*
* \param amp The #AMP handle.
* \param level The level settings to check.
* \param level The level settings bitmap.
*
* Checks if an amplifier is capable of *getting* a level setting. Since the
* \a level is an OR'ed bitwise argument, more than one level can be checked
* at the same time.
* Checks if an amplifier is capable of *getting* a level setting. Since the
* \a level is an OR'ed bitwise argument, more than one level can be checked
* at the same time.
*
* EXAMPLE: \code if (amp_has_get_level(my_amp, AMP_LVL_SWR)) disp_SWR();\endcode
* EXAMPLE:
* \code
* if (amp_has_get_level(my_amp, AMP_LVL_SWR))
* my_disp_SWR();
* \endcode
*
* \return A bit map of supported level settings that can be retrieved,
* otherwise 0 if none supported.
* otherwise 0 if none supported or \a amp is NULL or inconsistent.
*
* \sa amp_has_set_level(), amp_get_level()
*/
Expand Down
2 changes: 2 additions & 0 deletions src/amplifier.c
Original file line number Diff line number Diff line change
Expand Up @@ -703,6 +703,8 @@ const char *HAMLIB_API amp_get_info(AMP *amp)
*
* Query the \a val corresponding to the \a level.
*
* \note \a val can be any type defined by #value_t.
*
* \return RIG_OK if the operation was successful, otherwise a **negative
* value** if an error occurred (in which case, cause is set appropriately).
*
Expand Down
Loading

0 comments on commit 716866b

Please sign in to comment.