[libgdata/657539-tasks-tests: 13/19] tasks: Improve documentation for GDataTasksTask properties



commit 760ca0235f7b0e6413cd31cb371f5e3e83a8c490
Author: Philip Withnall <philip tecnocode co uk>
Date:   Sun Aug 31 00:10:07 2014 +0100

    tasks: Improve documentation for GDataTasksTask properties
    
    Better document the format of datetime-typed properties — they are the
    number of seconds since the UNIX epoch.

 gdata/services/tasks/gdata-tasks-task.c |   14 ++++++++++----
 1 files changed, 10 insertions(+), 4 deletions(-)
---
diff --git a/gdata/services/tasks/gdata-tasks-task.c b/gdata/services/tasks/gdata-tasks-task.c
index a2bec94..4551d72 100644
--- a/gdata/services/tasks/gdata-tasks-task.c
+++ b/gdata/services/tasks/gdata-tasks-task.c
@@ -155,8 +155,11 @@ gdata_tasks_task_class_init (GDataTasksTaskClass *klass)
        /**
         * GDataTasksTask:due:
         *
-        * Due date of the task (as a RFC 3339 timestamp).
-        * This field is <code class="literal">-1</code> if task has not due date asigned.
+        * Due date of the task (as a RFC 3339 timestamp; seconds since the UNIX
+        * epoch).
+        *
+        * This field is <code class="literal">-1</code> if the task has no due
+        * date assigned.
         *
         * Since: 0.15.0
         */
@@ -169,8 +172,11 @@ gdata_tasks_task_class_init (GDataTasksTaskClass *klass)
        /**
         * GDataTasksTask:completed:
         *
-        * Completion date of the task (as a RFC 3339 timestamp).
-        * This field is <code class="literal">-1</code> if the task has not been completed.
+        * Completion date of the task (as a RFC 3339 timestamp; seconds since
+        * the UNIX epoch).
+        *
+        * This field is <code class="literal">-1</code> if the task has not
+        * been completed.
         *
         * Since: 0.15.0
         */


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