From a70e447b30c3469f6ba0f973016dd2c8e94fd7a4 Mon Sep 17 00:00:00 2001
From: cash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Sun, 7 Feb 2010 18:46:36 +0000
Subject: tweaked some documentation on the REST API

git-svn-id: http://code.elgg.org/elgg/trunk@3918 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 engine/lib/api.php | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

(limited to 'engine/lib')

diff --git a/engine/lib/api.php b/engine/lib/api.php
index 9fbca5714..4bbd24969 100644
--- a/engine/lib/api.php
+++ b/engine/lib/api.php
@@ -1204,7 +1204,7 @@ function serialise_api_headers(array $headers) {
  * @param string $method GET or POST
  * @param string $post_data The post data
  * @param string $content_type The content type
- * @return stdClass The unserialised response object
+ * @return string
  */
 function send_api_call(array $keys, $url, array $call, $method = 'GET', $post_data = '', $content_type = 'application/octet-stream') {
 	global $CONFIG;
@@ -1293,7 +1293,7 @@ function send_api_call(array $keys, $url, array $call, $method = 'GET', $post_da
  * @param string $url URL of the endpoint.
  * @param array $call Associated array of "variable" => "value"
  * @param array $keys The keys dependant on chosen authentication method
- * @return stdClass The unserialised response object
+ * @return string
  */
 function send_api_get_call($url, array $call, array $keys) {
 	return send_api_call($keys, $url, $call);
@@ -1307,7 +1307,7 @@ function send_api_get_call($url, array $call, array $keys) {
  * @param array $keys The keys dependant on chosen authentication method
  * @param string $post_data The post data
  * @param string $content_type The content type
- * @return stdClass The unserialised response object
+ * @return string
  */
 function send_api_post_call($url, array $call, array $keys, $post_data, $content_type = 'application/octet-stream') {
 	return send_api_call($keys, $url, $call, 'POST', $post_data, $content_type);
@@ -1342,7 +1342,7 @@ function list_all_apis() {
 /**
  * The auth.gettoken API.
  * This API call lets a user log in, returning an authentication token which can be used
- * in leu of a username and password login for a specific period of time.
+ * to authenticate a user for a period of time.
  *
  * @param string $username Username
  * @param string $password Clear text password
-- 
cgit v1.2.3