From 3b1e983a519d0b4d820109e953d62bebd181c47c Mon Sep 17 00:00:00 2001
From: Martin Szulecki
Date: Thu, 2 Oct 2014 16:15:20 +0200
Subject: afc: Add documentation for afc_dictionary_free()

---
 include/libimobiledevice/afc.h | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'include/libimobiledevice')

diff --git a/include/libimobiledevice/afc.h b/include/libimobiledevice/afc.h
index 4b92fa0..667fd63 100644
--- a/include/libimobiledevice/afc.h
+++ b/include/libimobiledevice/afc.h
@@ -353,6 +353,13 @@ afc_error_t afc_set_file_time(afc_client_t client, const char *path, uint64_t mt
  */
 afc_error_t afc_get_device_info_key(afc_client_t client, const char *key, char **value);
 
+/**
+ * Frees up a char dictionary as returned by some AFC functions.
+ *
+ * @param dictionary The char array terminated by an empty string.
+ *
+ * @return AFC_E_SUCCESS on success or an AFC_E_* error value.
+ */
 afc_error_t afc_dictionary_free(char **dictionary);
 
 #ifdef __cplusplus
-- 
cgit v1.1-32-gdbae