summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Nikias Bassen2010-03-05 16:26:37 +0100
committerGravatar Matt Colyer2010-03-08 21:08:06 -0800
commit32b65dea4abc416320a97b8b7a438b90b2d449b0 (patch)
tree6f49f80a809e5a38b907992a14d7407b6cc54ec3
parentcb45bbfdcb67ad3d83a29574ae1f0706cd79a9e3 (diff)
downloadlibimobiledevice-32b65dea4abc416320a97b8b7a438b90b2d449b0.tar.gz
libimobiledevice-32b65dea4abc416320a97b8b7a438b90b2d449b0.tar.bz2
screenshotr: docs updated
-rw-r--r--src/screenshotr.c12
-rw-r--r--src/screenshotr.h2
2 files changed, 9 insertions, 5 deletions
diff --git a/src/screenshotr.c b/src/screenshotr.c
index f8866d0..11dce13 100644
--- a/src/screenshotr.c
+++ b/src/screenshotr.c
@@ -1,6 +1,6 @@
/*
* screenshotr.c
- * com.apple.mobile.screenshotr implementation.
+ * com.apple.mobile.screenshotr service implementation.
*
* Copyright (c) 2010 Nikias Bassen All Rights Reserved.
*
@@ -60,13 +60,16 @@ static screenshotr_error_t screenshotr_error(device_link_service_error_t err)
}
/**
- * Makes a connection to the screenshotr service on the device.
+ * Connects to the screenshotr service on the specified device.
*
* @param device The device to connect to.
* @param port Destination port (usually given by lockdownd_start_service).
* @param client Pointer that will be set to a newly allocated
* screenshotr_client_t upon successful return.
*
+ * @note This service is only available if a developer disk image has been
+ * mounted.
+ *
* @return SCREENSHOTR_E_SUCCESS on success, SCREENSHOTR_E_INVALID ARG if one
* or more parameters are invalid, or SCREENSHOTR_E_CONN_FAILED if the
* connection to the device could not be established.
@@ -100,9 +103,10 @@ screenshotr_error_t screenshotr_client_new(idevice_t device, uint16_t port,
}
/**
- * Disconnects a screenshotr client from the device.
+ * Disconnects a screenshotr client from the device and frees up the
+ * screenshotr client data.
*
- * @param client The client to disconnect.
+ * @param client The screenshotr client to disconnect and free.
*
* @return SCREENSHOTR_E_SUCCESS on success, or SCREENSHOTR_E_INVALID_ARG
* if client is NULL.
diff --git a/src/screenshotr.h b/src/screenshotr.h
index 5f842a7..97172dc 100644
--- a/src/screenshotr.h
+++ b/src/screenshotr.h
@@ -1,6 +1,6 @@
/*
* screenshotr.h
- * com.apple.mobile.screenshotr definitions.
+ * com.apple.mobile.screenshotr service header file.
*
* Copyright (c) 2010 Nikias Bassen All Rights Reserved.
*