summaryrefslogtreecommitdiff
path: root/libsocialweb/sw-service.h
diff options
context:
space:
mode:
authorEitan Isaacson <eitan.isaacson@collabora.co.uk>2011-03-01 21:24:15 (GMT)
committerEitan Isaacson <eitan.isaacson@collabora.co.uk>2011-03-01 21:25:15 (GMT)
commit4a75d4484127e5a8d65f3c72053bb7d559b0972e (patch)
treedb3ac6f55729d57c0b0941a9dc6444d0c7567fa8 /libsocialweb/sw-service.h
parent4021bcdbab959f7018e1843424aadfb05186a190 (diff)
downloadlibsocialweb-4a75d4484127e5a8d65f3c72053bb7d559b0972e.tar.gz
libsocialweb-4a75d4484127e5a8d65f3c72053bb7d559b0972e.tar.xz
Added documentation for sw_service_map_params.
Diffstat (limited to 'libsocialweb/sw-service.h')
-rw-r--r--libsocialweb/sw-service.h14
1 files changed, 13 insertions, 1 deletions
diff --git a/libsocialweb/sw-service.h b/libsocialweb/sw-service.h
index e199d03..ad6a710 100644
--- a/libsocialweb/sw-service.h
+++ b/libsocialweb/sw-service.h
@@ -105,9 +105,21 @@ typedef struct {
char *service_param;
} ParameterNameMapping;
+/**
+ * SwServiceSetParamFunc:
+ * @object: A remote call or hash object that can store key/value pairs.
+ * @param_name: The parameter name.
+ * @param_value: The parameter value.
+ *
+ * This type signature reflects a function that sets a name/value association
+ * on a given object. Functions such as g_hash_table_insert and
+ * rest_proxy_call_add_param are good examples.
+ */
+
+
typedef void (*SwServiceSetParamFunc) (gpointer object,
const gchar *param_name,
- const gchar *patam_value);
+ const gchar *param_value);
void sw_service_map_params (const ParameterNameMapping *mapping,
GHashTable *parameters,