si-interfaces: improve documentation on latest api additions

This commit is contained in:
George Kiagiadakis 2022-05-10 11:39:12 +03:00
parent 8dc4c36dd4
commit 85d0ecfb40
2 changed files with 20 additions and 0 deletions

View file

@ -92,6 +92,20 @@ wp_si_endpoint_get_properties (WpSiEndpoint * self)
/*!
* \struct WpSiAdapter
* An interface for port adapters
*
* \gsignals
*
* \par adapter-ports-state-changed
* \parblock
* \code
* void
* adapter_ports_state_changed_callback (WpSiAdapter * self,
* gpointer user_data)
* \endcode
* Emitted when the ports state changes
*
* Flags: G_SIGNAL_RUN_LAST
* \endparblock
*/
G_DEFINE_INTERFACE (WpSiAdapter, wp_si_adapter, WP_TYPE_SESSION_ITEM)
@ -110,6 +124,7 @@ wp_si_adapter_default_init (WpSiAdapterInterface * iface)
* \ingroup wpsiinterfaces
* \param self the session item
* \returns The state of the ports
* \since 0.4.10
*/
WpSiAdapterPortsState
wp_si_adapter_get_ports_state (WpSiAdapter * self)

View file

@ -52,6 +52,11 @@ WP_API
G_DECLARE_INTERFACE (WpSiAdapter, wp_si_adapter,
WP, SI_ADAPTER, WpSessionItem)
/*!
* \brief The ports configuration state of the adapter
* \ingroup wpsiinterfaces
* \since 0.4.10
*/
typedef enum {
WP_SI_ADAPTER_PORTS_STATE_NONE = 0, /*!< the ports have never been configured */
WP_SI_ADAPTER_PORTS_STATE_CONFIGURING, /*!< the ports are being configured */