[empathy] Add gtk-doc for new functions



commit c982861667c0441419ee4fdee2ea399ef8f26416
Author: Xavier Claessens <xclaesse gmail com>
Date:   Fri Apr 24 21:04:36 2009 +0200

    Add gtk-doc for new functions
---
 libempathy/empathy-tp-file.c |   16 ++++++++++++++++
 1 files changed, 16 insertions(+), 0 deletions(-)

diff --git a/libempathy/empathy-tp-file.c b/libempathy/empathy-tp-file.c
index 56f59a8..f003b0c 100644
--- a/libempathy/empathy-tp-file.c
+++ b/libempathy/empathy-tp-file.c
@@ -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)
 {



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]