diff options
| author | 2010-03-16 03:13:38 +0100 | |
|---|---|---|
| committer | 2010-03-16 03:13:38 +0100 | |
| commit | 08d2af5d611319748afba2aaba5e6c8a99f1b396 (patch) | |
| tree | 8bf4a3533f2acf11368dc37a9c653689ace99b77 /include/libimobiledevice/mobile_image_mounter.h | |
| parent | 3e0c5021100c879ff7d0776d4c7bb4f0ec88e0d7 (diff) | |
| download | libimobiledevice-08d2af5d611319748afba2aaba5e6c8a99f1b396.tar.gz libimobiledevice-08d2af5d611319748afba2aaba5e6c8a99f1b396.tar.bz2 | |
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.
Diffstat (limited to 'include/libimobiledevice/mobile_image_mounter.h')
| -rw-r--r-- | include/libimobiledevice/mobile_image_mounter.h | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/include/libimobiledevice/mobile_image_mounter.h b/include/libimobiledevice/mobile_image_mounter.h index 5681d8b..26a3666 100644 --- a/include/libimobiledevice/mobile_image_mounter.h +++ b/include/libimobiledevice/mobile_image_mounter.h | |||
| @@ -29,14 +29,17 @@ extern "C" { | |||
| 29 | 29 | ||
| 30 | #include <libimobiledevice/libimobiledevice.h> | 30 | #include <libimobiledevice/libimobiledevice.h> |
| 31 | 31 | ||
| 32 | /* Error Codes */ | 32 | /** @name Error Codes */ |
| 33 | /*@{*/ | ||
| 33 | #define MOBILE_IMAGE_MOUNTER_E_SUCCESS 0 | 34 | #define MOBILE_IMAGE_MOUNTER_E_SUCCESS 0 |
| 34 | #define MOBILE_IMAGE_MOUNTER_E_INVALID_ARG -1 | 35 | #define MOBILE_IMAGE_MOUNTER_E_INVALID_ARG -1 |
| 35 | #define MOBILE_IMAGE_MOUNTER_E_PLIST_ERROR -2 | 36 | #define MOBILE_IMAGE_MOUNTER_E_PLIST_ERROR -2 |
| 36 | #define MOBILE_IMAGE_MOUNTER_E_CONN_FAILED -3 | 37 | #define MOBILE_IMAGE_MOUNTER_E_CONN_FAILED -3 |
| 37 | 38 | ||
| 38 | #define MOBILE_IMAGE_MOUNTER_E_UNKNOWN_ERROR -256 | 39 | #define MOBILE_IMAGE_MOUNTER_E_UNKNOWN_ERROR -256 |
| 40 | /*@}*/ | ||
| 39 | 41 | ||
| 42 | /** Represents an error code. */ | ||
| 40 | typedef int16_t mobile_image_mounter_error_t; | 43 | typedef int16_t mobile_image_mounter_error_t; |
| 41 | 44 | ||
| 42 | typedef struct mobile_image_mounter_client_private mobile_image_mounter_client_private; | 45 | typedef struct mobile_image_mounter_client_private mobile_image_mounter_client_private; |
