Complete documentation of public interface and fix a lot of bogus comments

This change unifies the documentation comment syntax, fixes a few bad
documentation comments and completes documentation where it was missing.

1 files changed, 2 insertions, 1 deletions

diff --git a/src/device_link_service.h b/src/device_link_service.h
index c80686d..8b58ccf 100644
--- a/src/device_link_service.h
+++ b/src/device_link_service.h
@@ -32,12 +32,13 @@
 
 #define DEVICE_LINK_SERVICE_E_UNKNOWN_ERROR       -256
 
+/** Represents an error code. */
+typedef int16_t device_link_service_error_t;
 
 struct device_link_service_client_private {
         property_list_service_client_t parent;
 };
 
-typedef int16_t device_link_service_error_t;
 typedef struct device_link_service_client_private *device_link_service_client_t;
 
 device_link_service_error_t device_link_service_client_new(idevice_t device, uint16_t port, device_link_service_client_t *client);