LADI
/
jack-headers
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

tweak doxygen annotations to remove errors

This commit is contained in:
Paul Davis 2014-01-18 22:07:57 -05:00
parent 1bfa5e43ce
commit 742c63e024
2 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
jack.h
View File

@ -119,15 +119,24 @@ char *jack_get_client_name (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
/**
* @return pointer to a string representation of the UUID for
* a client named @param name. If no such client exists, return NULL
* a client named @param name . If no such client exists, return NULL
*
* @param client the client making the request
* @param name the name of the client whose UUID is desired
*
* Return NULL if no such client with the given name exists
*
*/
char *jack_get_uuid_for_client_name (jack_client_t *client,
const char *name) JACK_WEAK_EXPORT;
/**
* @return a pointer to the name of the client with the UUID
* specified by @param uuid.
* specified by uuid.
*
* @param client making the request
* @param uuid the uuid of the client whose name is desired
*
* Return NULL if no such client with the given UUID exists
*/
char *jack_get_client_name_by_uuid (jack_client_t *client,

11
metadata.h
View File

@ -135,7 +135,6 @@ jack_get_properties (jack_uuid_t subject,
/**
* Get descriptions for all subjects with metadata.
* @param subject The subject to get all properties of.
* @param descs Set to a NULL-terminated array of descriptions.
* The caller must free each of these with jack_free_desription(),
* and the array itself with jack_free().
@ -152,7 +151,7 @@ jack_get_all_properties (jack_description_t** descs);
*
* @return 0 on success, -1 otherwise
*/
int jack_remove_property (jack_client_t*, jack_uuid_t subject, const char* key);
int jack_remove_property (jack_client_t* client, jack_uuid_t subject, const char* key);
/** Remove all properties on a subject
*
@ -161,7 +160,7 @@ int jack_remove_property (jack_client_t*, jack_uuid_t subject, const char* key);
*
* @return a count of the number of properties removed, or -1 if an error occurs
*/
int jack_remove_properties (jack_client_t*, jack_uuid_t subject);
int jack_remove_properties (jack_client_t* client, jack_uuid_t subject);
/** Remove all properties
*
@ -173,7 +172,7 @@ int jack_remove_properties (jack_client_t*, jack_uuid_t subject);
*
* @return 0 on success, -1 otherwise
*/
int jack_remove_all_properties (jack_client_t*);
int jack_remove_all_properties (jack_client_t* client);
typedef enum {
PropertyCreated,
@ -189,6 +188,10 @@ typedef void (*JackPropertyChangeCallback)(jack_uuid_t subject,
/** Arrange for @param client to call @param callback whenever
* a property is created, changed or deleted.
*
* @param client the JACK client making the request
* @param callback the function to be invoked when a property change occurs
* @param arg the argument to be passed to @param callback when it is invoked
*
* @return 0 success, -1 otherwise.
*/
int jack_set_property_change_callback (jack_client_t* client,