Remove some duplicated #define-s with developer documentation comments

... by adding them into one common place.

5 files changed, 56 insertions, 107 deletions

diff --git a/src/addressbook/libebook-contacts/e-book-contacts-types.h b/src/addressbook/libebook-contacts/e-book-contacts-types.h
index eebdcf5a6..55c12c8b2 100644
--- a/src/addressbook/libebook-contacts/e-book-contacts-types.h
+++ b/src/addressbook/libebook-contacts/e-book-contacts-types.h
@@ -29,6 +29,45 @@
 #include <libebook-contacts/e-contact.h>
 
 /**
+ * BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS: (value "required-fields")
+ *
+ * Provides comma-separated list of required fields by the book backend.
+ * All of these attributes should be set, otherwise the backend will reject
+ * saving the contact.
+ *
+ * The e_contact_field_id() can be used to transform the field name
+ * into an #EContactField.
+ *
+ * Since: 3.2
+ **/
+#define BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS		"required-fields"
+
+/**
+ * BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS: (value "supported-fields")
+ *
+ * Provides comma-separated list of supported fields by the book backend.
+ * Attributes other than those listed here can be discarded. This can be
+ * used to enable/show only supported elements in GUI.
+ *
+ * The e_contact_field_id() can be used to transform the field name
+ * into an #EContactField.
+ *
+ * Since: 3.2
+ **/
+#define BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS		"supported-fields"
+
+/**
+ * BOOK_BACKEND_PROPERTY_REVISION: (value "revision")
+ *
+ * The current overall revision string, this can be used as
+ * a quick check to see if data has changed at all since the
+ * last time the addressbook revision was observed.
+ *
+ * Since: 3.4
+ **/
+#define BOOK_BACKEND_PROPERTY_REVISION			"revision"
+
+/**
  * E_BOOK_CLIENT_ERROR:
  *
  * Error domain for #EBookClient errors
diff --git a/src/addressbook/libebook/e-book-client.h b/src/addressbook/libebook/e-book-client.h
index 9eaa4ad32..683c07aaa 100644
--- a/src/addressbook/libebook/e-book-client.h
+++ b/src/addressbook/libebook/e-book-client.h
@@ -50,24 +50,6 @@
 	(G_TYPE_INSTANCE_GET_CLASS \
 	((obj), E_TYPE_BOOK_CLIENT, EBookClientClass))
 
-/**
- * BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS: (value "required-fields")
- *
- * FIXME: Document me.
- *
- * Since: 3.2
- **/
-#define BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS		"required-fields"
-
-/**
- * BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS: (value "supported-fields")
- *
- * FIXME: Document me.
- *
- * Since: 3.2
- **/
-#define BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS		"supported-fields"
-
 G_BEGIN_DECLS
 
 typedef struct _EBookClient EBookClient;
diff --git a/src/addressbook/libedata-book/e-book-backend.h b/src/addressbook/libedata-book/e-book-backend.h
index cffaa40c3..f44d36c95 100644
--- a/src/addressbook/libedata-book/e-book-backend.h
+++ b/src/addressbook/libedata-book/e-book-backend.h
@@ -54,44 +54,6 @@
 	(G_TYPE_INSTANCE_GET_CLASS \
 	((obj), E_TYPE_BOOK_BACKEND, EBookBackendClass))
 
-/**
- * CLIENT_BACKEND_PROPERTY_CAPABILITIES:
- *
- * FIXME: Document me.
- *
- * Since: 3.2
- **/
-#define CLIENT_BACKEND_PROPERTY_CAPABILITIES		"capabilities"
-
-/**
- * BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS:
- *
- * FIXME: Document me.
- *
- * Since: 3.2
- **/
-#define BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS		"required-fields"
-
-/**
- * BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS:
- *
- * FIXME: Document me.
- *
- * Since: 3.2
- **/
-#define BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS		"supported-fields"
-
-/**
- * BOOK_BACKEND_PROPERTY_REVISION:
- *
- * The current overall revision string, this can be used as
- * a quick check to see if data has changed at all since the
- * last time the addressbook revision was observed.
- *
- * Since: 3.4
- **/
-#define BOOK_BACKEND_PROPERTY_REVISION			"revision"
-
 G_BEGIN_DECLS
 
 typedef struct _EBookBackend EBookBackend;
diff --git a/src/calendar/libecal/e-cal-client.h b/src/calendar/libecal/e-cal-client.h
index f7ffce838..5e04986bb 100644
--- a/src/calendar/libecal/e-cal-client.h
+++ b/src/calendar/libecal/e-cal-client.h
@@ -53,7 +53,7 @@
 /**
  * CAL_BACKEND_PROPERTY_CAL_EMAIL_ADDRESS:
  *
- * FIXME: Document me.
+ * An email address associated with the calendar.
  *
  * Since: 3.2
  **/
@@ -62,7 +62,7 @@
 /**
  * CAL_BACKEND_PROPERTY_ALARM_EMAIL_ADDRESS:
  *
- * FIXME: Document me.
+ * An email address preferred for e-mail reminders by the calendar.
  *
  * Since: 3.2
  **/
@@ -71,16 +71,29 @@
 /**
  * CAL_BACKEND_PROPERTY_DEFAULT_OBJECT:
  *
- * FIXME: Document me.
+ * A default object for the calendar. Calendars use VEVENT, memo lists VJOURNAL
+ * and task lists VTODO, which can have prefilled values by the backend.
  *
  * Since: 3.2
  **/
 #define CAL_BACKEND_PROPERTY_DEFAULT_OBJECT		"default-object"
 
 /**
+ * CAL_BACKEND_PROPERTY_REVISION:
+ *
+ * The current overall revision string, this can be used as
+ * a quick check to see if data has changed at all since the
+ * last time the calendar revision was observed.
+ *
+ * Since: 3.4
+ **/
+#define CAL_BACKEND_PROPERTY_REVISION			"revision"
+
+/**
  * E_CAL_CLIENT_ERROR:
  *
- * FIXME: Document me.
+ * An error domain associated with #ECalClient. The error codes
+ * are from #ECalClientError.
  *
  * Since: 3.2
  **/
diff --git a/src/calendar/libedata-cal/e-cal-backend.h b/src/calendar/libedata-cal/e-cal-backend.h
index 91d52c7e9..9836d413d 100644
--- a/src/calendar/libedata-cal/e-cal-backend.h
+++ b/src/calendar/libedata-cal/e-cal-backend.h
@@ -46,53 +46,6 @@
 	(G_TYPE_INSTANCE_GET_CLASS \
 	((obj), E_TYPE_CAL_BACKEND, ECalBackendClass))
 
-/**
- * CLIENT_BACKEND_PROPERTY_CAPABILITIES:
- *
- * FIXME: Document me.
- *
- * Since: 3.2
- **/
-#define CLIENT_BACKEND_PROPERTY_CAPABILITIES		"capabilities"
-
-/**
- * CAL_BACKEND_PROPERTY_CAL_EMAIL_ADDRESS:
- *
- * FIXME: Document me.
- *
- * Since: 3.2
- **/
-#define CAL_BACKEND_PROPERTY_CAL_EMAIL_ADDRESS		"cal-email-address"
-
-/**
- * CAL_BACKEND_PROPERTY_ALARM_EMAIL_ADDRESS:
- *
- * FIXME: Document me.
- *
- * Since: 3.2
- **/
-#define CAL_BACKEND_PROPERTY_ALARM_EMAIL_ADDRESS	"alarm-email-address"
-
-/**
- * CAL_BACKEND_PROPERTY_DEFAULT_OBJECT:
- *
- * FIXME: Document me.
- *
- * Since: 3.2
- **/
-#define CAL_BACKEND_PROPERTY_DEFAULT_OBJECT		"default-object"
-
-/**
- * CAL_BACKEND_PROPERTY_REVISION:
- *
- * The current overall revision string, this can be used as
- * a quick check to see if data has changed at all since the
- * last time the calendar revision was observed.
- *
- * Since: 3.4
- **/
-#define CAL_BACKEND_PROPERTY_REVISION			"revision"
-
 G_BEGIN_DECLS
 
 struct _ECalBackendCache;