From 4160aa2e97cea2c665c286e43133079dce42e408 Mon Sep 17 00:00:00 2001
From: Martin Szulecki
Date: Tue, 25 May 2010 11:43:15 +0200
Subject: Update brief documentation to be consistent and easier to understand

---
 include/libimobiledevice/afc.h                  | 2 +-
 include/libimobiledevice/file_relay.h           | 2 +-
 include/libimobiledevice/installation_proxy.h   | 2 +-
 include/libimobiledevice/lockdown.h             | 2 +-
 include/libimobiledevice/mobile_image_mounter.h | 2 +-
 include/libimobiledevice/mobilebackup.h         | 2 +-
 include/libimobiledevice/mobilesync.h           | 2 +-
 include/libimobiledevice/notification_proxy.h   | 2 +-
 include/libimobiledevice/restore.h              | 2 +-
 include/libimobiledevice/sbservices.h           | 2 +-
 include/libimobiledevice/screenshotr.h          | 3 ++-
 11 files changed, 12 insertions(+), 11 deletions(-)

(limited to 'include/libimobiledevice')

diff --git a/include/libimobiledevice/afc.h b/include/libimobiledevice/afc.h
index c060eb7..5b06e2c 100644
--- a/include/libimobiledevice/afc.h
+++ b/include/libimobiledevice/afc.h
@@ -1,6 +1,6 @@
 /**
  * @file libimobiledevice/afc.h
- * @brief AFC Implementation
+ * @brief Access the filesystem.
  * \internal
  *
  * Copyright (c) 2009 Nikias Bassen All Rights Reserved.
diff --git a/include/libimobiledevice/file_relay.h b/include/libimobiledevice/file_relay.h
index b3900db..52d4758 100644
--- a/include/libimobiledevice/file_relay.h
+++ b/include/libimobiledevice/file_relay.h
@@ -1,6 +1,6 @@
 /**
  * @file libimobiledevice/file_relay.h
- * @brief file_relay Implementation
+ * @brief Retrieve compressed CPIO archives.
  * \internal
  *
  * Copyright (c) 2010 Nikias Bassen All Rights Reserved.
diff --git a/include/libimobiledevice/installation_proxy.h b/include/libimobiledevice/installation_proxy.h
index bee9a16..f5f00e8 100644
--- a/include/libimobiledevice/installation_proxy.h
+++ b/include/libimobiledevice/installation_proxy.h
@@ -1,6 +1,6 @@
 /**
  * @file libimobiledevice/installation_proxy.h
- * @brief Implementation to talk to the installation proxy on a device
+ * @brief Manage applications on a device.
  * \internal
  *
  * Copyright (c) 2009 Nikias Bassen All Rights Reserved.
diff --git a/include/libimobiledevice/lockdown.h b/include/libimobiledevice/lockdown.h
index 9a02e69..97df6b0 100644
--- a/include/libimobiledevice/lockdown.h
+++ b/include/libimobiledevice/lockdown.h
@@ -1,6 +1,6 @@
 /**
  * @file libimobiledevice/lockdown.h
- * @brief Implementation to communicate with the lockdown device daemon
+ * @brief Manage device preferences, start services, pairing and activation.
  * \internal
  *
  * Copyright (c) 2008 Zach C. All Rights Reserved.
diff --git a/include/libimobiledevice/mobile_image_mounter.h b/include/libimobiledevice/mobile_image_mounter.h
index 26a3666..04c65d5 100644
--- a/include/libimobiledevice/mobile_image_mounter.h
+++ b/include/libimobiledevice/mobile_image_mounter.h
@@ -1,6 +1,6 @@
 /**
  * @file libimobiledevice/mobile_image_mounter.h
- * @brief Implementation of the mobile image mounter service.
+ * @brief Mount developer/debug disk images on the device.
  * \internal
  *
  * Copyright (c) 2010 Nikias Bassen All Rights Reserved.
diff --git a/include/libimobiledevice/mobilebackup.h b/include/libimobiledevice/mobilebackup.h
index 6f37a14..7dbc3fe 100644
--- a/include/libimobiledevice/mobilebackup.h
+++ b/include/libimobiledevice/mobilebackup.h
@@ -1,6 +1,6 @@
 /**
  * @file libimobiledevice/mobilebackup.h
- * @brief MobileBackup Implementation
+ * @brief Backup and restore of all device data.
  * \internal
  *
  * Copyright (c) 2009 Martin Szulecki All Rights Reserved.
diff --git a/include/libimobiledevice/mobilesync.h b/include/libimobiledevice/mobilesync.h
index 6e2d8b4..64f75a8 100644
--- a/include/libimobiledevice/mobilesync.h
+++ b/include/libimobiledevice/mobilesync.h
@@ -1,6 +1,6 @@
 /**
  * @file libimobiledevice/mobilesync.h
- * @brief MobileSync Implementation
+ * @brief Synchronize data classes with a device and computer.
  * \internal
  *
  * Copyright (c) 2010 Bryan Forbes All Rights Reserved.
diff --git a/include/libimobiledevice/notification_proxy.h b/include/libimobiledevice/notification_proxy.h
index d85f56c..6e4409d 100644
--- a/include/libimobiledevice/notification_proxy.h
+++ b/include/libimobiledevice/notification_proxy.h
@@ -1,6 +1,6 @@
 /**
  * @file libimobiledevice/notification_proxy.h
- * @brief Implementation to talk to the notification proxy on a device
+ * @brief Observe and post notifications.
  * \internal
  *
  * Copyright (c) 2009 Nikias Bassen All Rights Reserved.
diff --git a/include/libimobiledevice/restore.h b/include/libimobiledevice/restore.h
index c4b5916..6f3ff53 100644
--- a/include/libimobiledevice/restore.h
+++ b/include/libimobiledevice/restore.h
@@ -1,6 +1,6 @@
 /**
  * @file libimobiledevice/restore.h
- * @brief Implementation to communicate with the restore device daemon
+ * @brief Initiate restore process or reboot device.
  * \internal
  *
  * Copyright (c) 2010 Joshua Hill. All Rights Reserved.
diff --git a/include/libimobiledevice/sbservices.h b/include/libimobiledevice/sbservices.h
index 71e951e..fcedf1a 100644
--- a/include/libimobiledevice/sbservices.h
+++ b/include/libimobiledevice/sbservices.h
@@ -1,6 +1,6 @@
 /**
  * @file libimobiledevice/sbservices.h
- * @brief Implementation to talk to the SpringBoard services on a device
+ * @brief Manage SpringBoard icons and retrieve icon images.
  * \internal
  *
  * Copyright (c) 2009 Nikias Bassen All Rights Reserved.
diff --git a/include/libimobiledevice/screenshotr.h b/include/libimobiledevice/screenshotr.h
index 7e5c8a7..b3669ee 100644
--- a/include/libimobiledevice/screenshotr.h
+++ b/include/libimobiledevice/screenshotr.h
@@ -1,6 +1,7 @@
 /**
  * @file libimobiledevice/screenshotr.h
- * @brief Screenshot service implementation
+ * @brief Retrieve a screenshot from device.
+ * @note Requires a mounted developer image.
  * \internal
  *
  * Copyright (c) 2010 Nikias Bassen All Rights Reserved.
-- 
cgit v1.1-32-gdbae