add docs to properties

1 files changed, 20 insertions, 1 deletions

diff --git a/src/pop-transaction.c b/src/pop-transaction.c
index dba5177..0c7bebe 100644
--- a/src/pop-transaction.c
+++ b/src/pop-transaction.c
@@ -261,12 +261,25 @@ pop_transaction_class_install_properties (
 
   /* FIXME: do the whole enum gtype song and dance
    */
+  /**
+   * PopTransaction:status:
+   *
+   * A transaction may be pending, successfully or
+   * unsuccessfully finished. This property says which state the
+   * transaction is currently in.
+   */
   param_spec = g_param_spec_int ("status", _ ("Status"),
                                  _ ("Current status of the transaction"),
                                  POP_TRANSACTION_STATUS_NOT_FINISHED,
                                  POP_TRANSACTION_STATUS_SUCCEEDED,
                                  POP_TRANSACTION_STATUS_NOT_FINISHED,
-                                 G_PARAM_READABLE);
+                                G_PARAM_READABLE);
+  /**
+   * PopTransaction:result:
+   *
+   * The last action in a transaction may set some sort of output or result.
+   * If it does, then this property contains that result.
+   */
   g_object_class_install_property (object_class, PROP_STATUS, param_spec);
 
   param_spec = g_param_spec_pointer ("result", _ ("Result"),
@@ -274,6 +287,12 @@ pop_transaction_class_install_properties (
                                      G_PARAM_READABLE);
   g_object_class_install_property (object_class, PROP_RESULT, param_spec);
 
+  /**
+   * PopTransaction:error:
+   *
+   * When an action fails it may set a #GError on the transaction with a
+   * reason why the action failed.  This property is the error.
+   */
   param_spec = g_param_spec_pointer ("error", _ ("Error"),
                                      _ ("Reason for transaction error"),
                                      G_PARAM_READWRITE);