]> git.0d.be Git - empathy.git/commitdiff
Add gtk-doc for new functions
authorXavier Claessens <xclaesse@gmail.com>
Fri, 24 Apr 2009 19:04:36 +0000 (21:04 +0200)
committerXavier Claessens <xclaesse@gmail.com>
Fri, 24 Apr 2009 19:21:29 +0000 (21:21 +0200)
libempathy/empathy-tp-file.c

index 56f59a83ab9c7618ca30212f3ad85fd95d04d31e..f003b0c70639c42d6ec89c91c9e9c348110995cb 100644 (file)
@@ -1043,6 +1043,14 @@ empathy_tp_file_get_transferred_bytes (EmpathyTpFile *tp_file)
   return tp_file->priv->transferred_bytes;
 }
 
+/**
+ * empathy_tp_file_get_remaining_time:
+ * @tp_file: a #EmpathyTpFile
+ *
+ * Get the current remaining time estimation, in seconds.
+ *
+ * Returns: The time remaining.
+ **/
 gint
 empathy_tp_file_get_remaining_time (EmpathyTpFile *tp_file)
 {
@@ -1057,6 +1065,14 @@ empathy_tp_file_get_remaining_time (EmpathyTpFile *tp_file)
   return tp_file->priv->remaining_time;
 }
 
+/**
+ * empathy_tp_file_get_speed:
+ * @tp_file: a #EmpathyTpFile
+ *
+ * Get the current speed of the transfer, in bytes per seconds.
+ *
+ * Returns: The current speed.
+ **/
 gdouble
 empathy_tp_file_get_speed (EmpathyTpFile *tp_file)
 {