docs: fix up SignonError
authorAlexander Kanavin <alexander.kanavin@intel.com>
Fri, 30 Aug 2013 15:11:47 +0000 (18:11 +0300)
committerAlexander Kanavin <alexander.kanavin@intel.com>
Wed, 4 Sep 2013 16:02:56 +0000 (19:02 +0300)
libgsignon-glib/signon-errors.c
libgsignon-glib/signon-errors.h

index 1ffb3015c121866d00317c47b8c11f09b91388f1..44feaa0fdf6e17642a56ec9cbd9ddeafe45bbb9f 100644 (file)
 /**
  * SECTION:signon-errors
  * @title: SignonError
- * @short_description: Possible errors from Signon.
+ * @short_description: possible gSSO errors
  *
- * An enumeration of errors that are possible from Signon.
+ * An enumeration of errors that are possible when using gSSO
  */
 #define SIGNON_ERROR_PREFIX SIGNOND_SERVICE_PREFIX ".Error"
 
 #include "signon-errors-map.c"
 
+/**
+ * signon_error_quark:
+ * 
+ * Creates and returns a domain for gSSO errors.
+ */
 GQuark signon_error_quark (void)
 {
     static volatile gsize quark = 0;
index 423d6675360787c11ab4703bfcccbd76852fe907..a81a225d2a0f4ecfabd4ecfa37a5a2cf47fad8bb 100644 (file)
 #include <glib-object.h>
 #include "signon-enum-types.h"
 
+/**
+ * SIGNON_ERROR:
+ *
+ * This macro is used when creating a #GError in libgsignond-glib library
+ */
 #define SIGNON_ERROR (signon_error_quark())
 
+//FIXME: reuse error definitions from libgsignond-common
 /**
  * SignonError:
  * @SIGNON_ERROR_UNKNOWN: Catch-all for errors not distinguished by another code.