file-transfer: Add documentation for public functions

Acked-by: Victor Toso <victortoso@redhat.com>

1 files changed, 33 insertions, 12 deletions

diff --git a/src/spice-file-transfer-task.c b/src/spice-file-transfer-task.c
index aa9d95b..2d42b61 100644
--- a/src/spice-file-transfer-task.c
+++ b/src/spice-file-transfer-task.c
@@ -352,18 +352,6 @@ GCancellable *spice_file_transfer_task_get_cancellable(SpiceFileTransferTask *se
     return self->cancellable;
 }
 
-guint64 spice_file_transfer_task_get_total_bytes(SpiceFileTransferTask *self)
-{
-    g_return_val_if_fail(self != NULL, 0);
-    return self->file_size;
-}
-
-guint64 spice_file_transfer_task_get_transferred_bytes(SpiceFileTransferTask *self)
-{
-    g_return_val_if_fail(self != NULL, 0);
-    return self->read_bytes;
-}
-
 /* Helper function which only creates a SpiceFileTransferTask per GFile
  * in @files and returns a HashTable mapping task-id to the task itself
  * The SpiceFileTransferTask created here has two references, one should be
@@ -552,6 +540,39 @@ char* spice_file_transfer_task_get_filename(SpiceFileTransferTask *self)
     return g_file_get_basename(self->file);
 }
 
+/**
+ * spice_file_transfer_task_get_total_bytes:
+ * @self: a file transfer task
+ *
+ * Gets the total size in bytes of the file transfer.
+ *
+ * Returns: The total size of the file transfer
+ *
+ * Since: 0.33
+ **/
+guint64 spice_file_transfer_task_get_total_bytes(SpiceFileTransferTask *self)
+{
+    g_return_val_if_fail(self != NULL, 0);
+    return self->file_size;
+}
+
+
+/**
+ * spice_file_transfer_task_get_transferred_bytes:
+ * @self: a file transfer task
+ *
+ * Gets the number of bytes that have been transferred so far.
+ *
+ * Returns: The number of transferred bytes
+ *
+ * Since: 0.33
+ **/
+guint64 spice_file_transfer_task_get_transferred_bytes(SpiceFileTransferTask *self)
+{
+    g_return_val_if_fail(self != NULL, 0);
+    return self->read_bytes;
+}
+
 /*******************************************************************************
  * GObject
  ******************************************************************************/