diff options
| author | 2011-03-11 22:56:55 +0100 | |
|---|---|---|
| committer | 2011-03-12 03:18:22 +0100 | |
| commit | 559b81461e699c00b418e36e0873d2d7e0c6860c (patch) | |
| tree | 1622d0061afc2fb838e5ff90ff69d9c608c96ffd /src | |
| parent | 0b0ce44c138e57d7e638bd8d400ec5260c92d9c7 (diff) | |
| download | libimobiledevice-559b81461e699c00b418e36e0873d2d7e0c6860c.tar.gz libimobiledevice-559b81461e699c00b418e36e0873d2d7e0c6860c.tar.bz2 | |
Add some doxygen markup to mobilesync API doc
Add some missing (), \a and # to let doxygen know that something
is a function, a parameter name or a type. This lets doxygen
formats these elements in a nicer way (by creating links, changing
the font, ...)
Diffstat (limited to 'src')
| -rw-r--r-- | src/mobilesync.c | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/mobilesync.c b/src/mobilesync.c index 4a54851..c444c8e 100644 --- a/src/mobilesync.c +++ b/src/mobilesync.c | |||
| @@ -39,12 +39,12 @@ | |||
| 39 | #define EMPTY_PARAMETER_STRING "___EmptyParameterString___" | 39 | #define EMPTY_PARAMETER_STRING "___EmptyParameterString___" |
| 40 | 40 | ||
| 41 | /** | 41 | /** |
| 42 | * Convert an device_link_service_error_t value to an mobilesync_error_t value. | 42 | * Convert an #device_link_service_error_t value to an #mobilesync_error_t value. |
| 43 | * Used internally to get correct error codes when using device_link_service stuff. | 43 | * Used internally to get correct error codes when using device_link_service stuff. |
| 44 | * | 44 | * |
| 45 | * @param err A device_link_service_error_t error code | 45 | * @param err A #device_link_service_error_t error code |
| 46 | * | 46 | * |
| 47 | * @return A matching mobilesync_error_t error code, | 47 | * @return A matching #mobilesync_error_t error code, |
| 48 | * MOBILESYNC_E_UNKNOWN_ERROR otherwise. | 48 | * MOBILESYNC_E_UNKNOWN_ERROR otherwise. |
| 49 | */ | 49 | */ |
| 50 | static mobilesync_error_t mobilesync_error(device_link_service_error_t err) | 50 | static mobilesync_error_t mobilesync_error(device_link_service_error_t err) |
| @@ -70,9 +70,9 @@ static mobilesync_error_t mobilesync_error(device_link_service_error_t err) | |||
| 70 | * Connects to the mobilesync service on the specified device. | 70 | * Connects to the mobilesync service on the specified device. |
| 71 | * | 71 | * |
| 72 | * @param device The device to connect to. | 72 | * @param device The device to connect to. |
| 73 | * @param port Destination port (usually given by lockdownd_start_service). | 73 | * @param port Destination port (usually given by lockdownd_start_service()). |
| 74 | * @param client Pointer that will be set to a newly allocated | 74 | * @param client Pointer that will be set to a newly allocated |
| 75 | * mobilesync_client_t upon successful return. | 75 | * #mobilesync_client_t upon successful return. |
| 76 | * | 76 | * |
| 77 | * @retval MOBILESYNC_E_SUCCESS on success | 77 | * @retval MOBILESYNC_E_SUCCESS on success |
| 78 | * @retval MOBILESYNC_E_INVALID_ARG if one or more parameters are invalid | 78 | * @retval MOBILESYNC_E_INVALID_ARG if one or more parameters are invalid |
| @@ -116,7 +116,7 @@ mobilesync_error_t mobilesync_client_new(idevice_t device, uint16_t port, | |||
| 116 | * @param client The mobilesync client to disconnect and free. | 116 | * @param client The mobilesync client to disconnect and free. |
| 117 | * | 117 | * |
| 118 | * @retval MOBILESYNC_E_SUCCESS on success | 118 | * @retval MOBILESYNC_E_SUCCESS on success |
| 119 | * @retval MOBILESYNC_E_INVALID_ARG if client is NULL. | 119 | * @retval MOBILESYNC_E_INVALID_ARG if \a client is NULL. |
| 120 | */ | 120 | */ |
| 121 | mobilesync_error_t mobilesync_client_free(mobilesync_client_t client) | 121 | mobilesync_error_t mobilesync_client_free(mobilesync_client_t client) |
| 122 | { | 122 | { |
| @@ -805,7 +805,7 @@ mobilesync_error_t mobilesync_cancel(mobilesync_client_t client, const char* rea | |||
| 805 | * if none is known yet which for instance is true on first synchronization. | 805 | * if none is known yet which for instance is true on first synchronization. |
| 806 | * @param computer_anchor An arbitrary string to use as anchor for the computer. | 806 | * @param computer_anchor An arbitrary string to use as anchor for the computer. |
| 807 | * | 807 | * |
| 808 | * @return A new mobilesync_anchors_t struct. Must be freed using mobilesync_anchors_free(). | 808 | * @return A new #mobilesync_anchors_t struct. Must be freed using mobilesync_anchors_free(). |
| 809 | */ | 809 | */ |
| 810 | mobilesync_anchors_t mobilesync_anchors_new(const char *device_anchor, const char *computer_anchor) | 810 | mobilesync_anchors_t mobilesync_anchors_new(const char *device_anchor, const char *computer_anchor) |
| 811 | { | 811 | { |
