endpoint: improve GVariant format docs

This commit is contained in:
George Kiagiadakis
2019-05-25 23:19:28 +03:00
parent d2ccd2996b
commit 901593e217

View File

@@ -81,6 +81,7 @@
* "name": the name of the control * "name": the name of the control
* "type": a GVariant type string * "type": a GVariant type string
* "range": a tuple (min, max) * "range": a tuple (min, max)
* "default-value": the default value
*/ */
#include "endpoint.h" #include "endpoint.h"
@@ -386,9 +387,8 @@ wp_endpoint_list_controls (WpEndpoint * self)
* @self: the endpoint * @self: the endpoint
* @control_id: the id of the control to set * @control_id: the id of the control to set
* *
* Returns a dictionary GVariant containing two fields: * Returns a GVariant that holds the value of the control. The type
* * "id": a uint32 representing the control id * should be the same type specified in the control variant's "type" field.
* * "value": a variant containing the value of the control
* *
* On error, NULL will be returned. * On error, NULL will be returned.
* *