[empathy: 115/148] Clarify a bit the docs about checksumming
- From: Cosimo Cecchi <cosimoc src gnome org>
- To: svn-commits-list gnome org
- Subject: [empathy: 115/148] Clarify a bit the docs about checksumming
- Date: Mon, 1 Jun 2009 12:17:26 -0400 (EDT)
commit c23cff9fadeae104feff7c19764bafaff78cfbd6
Author: Cosimo Cecchi <cosimo cecchi collabora co uk>
Date: Wed May 20 12:34:23 2009 +0200
Clarify a bit the docs about checksumming
---
libempathy/empathy-ft-handler.c | 8 ++++++--
1 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/libempathy/empathy-ft-handler.c b/libempathy/empathy-ft-handler.c
index d537f48..3dc790f 100644
--- a/libempathy/empathy-ft-handler.c
+++ b/libempathy/empathy-ft-handler.c
@@ -404,7 +404,9 @@ empathy_ft_handler_class_init (EmpathyFTHandlerClass *klass)
* is started. Note that this only happens if the handler is created
* with checksum enabled and, even if the option is set, is not
* guaranteed to happen for incoming handlers, as the CM might not
- * support sending/receiving the file hash.
+ * support sending/receiving the file hash. You can use
+ * empathy_ft_handler_get_use_hash() to find out whether the handler really
+ * supports checksum.
*/
signals[HASHING_STARTED] =
g_signal_new ("hashing-started", G_TYPE_FROM_CLASS (klass),
@@ -1383,7 +1385,9 @@ empathy_ft_handler_get_gfile (EmpathyFTHandler *handler)
* empathy_ft_handler_get_use_hash:
* @handler: an #EmpathyFTHandler
*
- * Returns whether @handler has checksumming enabled.
+ * Returns whether @handler has checksumming enabled. Note that if the CM
+ * doesn't support sending/receiving the checksum, this can return %FALSE even
+ * if the handler was created with the use_hash parameter set to %TRUE.
*
* Return value: %TRUE if the handler has checksumming enabled,
* %FALSE otherwise.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]