Update Doxygen comments for rot_state.h

pull/1812/head
Nate Bargmann 2025-07-22 21:01:23 -05:00
rodzic 1eb645004a
commit 98cc0b688e
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: FB2C5130D55A8819
2 zmienionych plików z 24 dodań i 4 usunięć

Wyświetl plik

@ -6,11 +6,12 @@ dist_man_MANS = man1/ampctl.1 man1/ampctld.1 \
man7/hamlib.7 man7/hamlib-primer.7 man7/hamlib-utilities.7
SRCDOCLST = \
../include/hamlib/amp_state.h \
../include/hamlib/amplifier.h \
../include/hamlib/amplist.h \
../include/hamlib/amp_state.h \
../include/hamlib/port.h \
../include/hamlib/rig.h \
../include/hamlib/rot_state.h \
../include/hamlib/rotator.h \
../include/hamlib/rotlist.h \
../src/amp_conf.c \

Wyświetl plik

@ -25,10 +25,26 @@
#define _ROT_STATE_H 1
__BEGIN_DECLS
/**
* \addtogroup rotator
* @{
*/
/**
* \brief Hamlib rotator data structures.
*
* \file rot_state.h
*
* This file contains the live data state structure of the rotator.
*/
/**
* \struct rot_state
* \brief Rotator state structure
*
* \struct rot_state
*
* This structure contains live data, as well as a copy of capability fields
* that may be updated, i.e. customized while the #ROT handle is instantiated.
*
@ -72,8 +88,8 @@ struct rot_state {
int current_speed; /*!< Current speed 1-100, to be used when no change to speed is requested. */
hamlib_port_t rotport; /*!< Rotator port (internal use). */
hamlib_port_t rotport2; /*!< 2nd Rotator port (internal use). */
rig_ptr_t *pstrotator_handler_priv_data;
deferred_config_header_t config_queue;
rig_ptr_t *pstrotator_handler_priv_data; /*!< PstRotator private data. */
deferred_config_header_t config_queue; /*!< Que for deferred processing. */
};
__END_DECLS
@ -81,6 +97,9 @@ __END_DECLS
#if defined(IN_HAMLIB)
#define ROTSTATE(r) (&(r)->state)
#endif
/** Macro for application access to rot_state data structure. */
#define HAMLIB_ROTSTATE(r) ((struct rot_state *)rot_data_pointer(r, RIG_PTRX_ROTSTATE))
#endif /* _ROT_STATE_H */
/** @} */