[evolution-data-server] e-data-cal.h readability cleanups.

[Matthew Barnes <mbarnes src gnome org>]

commit 33543ac3cd8e4b9f885893479f906359f2c6b64c
Author: Matthew Barnes <mbarnes redhat com>
Date:   Sat Oct 6 16:14:31 2012 -0400

    e-data-cal.h readability cleanups.

 calendar/libedata-cal/e-data-cal.c                 |   10 +
 calendar/libedata-cal/e-data-cal.h                 |  192 +++++++++++++-------
 .../libedata-cal/libedata-cal-sections.txt         |    1 +
 3 files changed, 140 insertions(+), 63 deletions(-)
---
diff --git a/calendar/libedata-cal/e-data-cal.c b/calendar/libedata-cal/e-data-cal.c
index 69a9e8d..896285a 100644
--- a/calendar/libedata-cal/e-data-cal.c
+++ b/calendar/libedata-cal/e-data-cal.c
@@ -454,6 +454,13 @@ e_data_cal_status_to_string (EDataCalCallStatus status)
 
 /**
  * e_data_cal_create_error:
+ * @status: #EDataCalStatus code
+ * @custom_msg: Custom message to use for the error. When NULL,
+ *              then uses a default message based on the @status code.
+ *
+ * Returns: NULL, when the @status is Success,
+ *          or a newly allocated GError, which should be freed
+ *          with g_error_free() call.
  *
  * Since: 2.32
  **/
@@ -470,6 +477,9 @@ e_data_cal_create_error (EDataCalCallStatus status,
 /**
  * e_data_cal_create_error_fmt:
  *
+ * Similar as e_data_cal_create_error(), only here, instead of custom_msg,
+ * is used a printf() format to create a custom_msg for the error.
+ *
  * Since: 2.32
  **/
 GError *
diff --git a/calendar/libedata-cal/e-data-cal.h b/calendar/libedata-cal/e-data-cal.h
index cc4ad52..9414248 100644
--- a/calendar/libedata-cal/e-data-cal.h
+++ b/calendar/libedata-cal/e-data-cal.h
@@ -30,17 +30,24 @@
 #include <gio/gio.h>
 #include <libedata-cal/e-data-cal-view.h>
 
-G_BEGIN_DECLS
-
-
-
-#define E_TYPE_DATA_CAL            (e_data_cal_get_type ())
-#define E_DATA_CAL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), E_TYPE_DATA_CAL, EDataCal))
-#define E_DATA_CAL_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), E_TYPE_DATA_CAL, EDataCalClass))
-#define E_IS_DATA_CAL(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), E_TYPE_DATA_CAL))
-#define E_IS_DATA_CAL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), E_TYPE_DATA_CAL))
-
-GQuark e_data_cal_error_quark (void);
+/* Standard GObject macros */
+#define E_TYPE_DATA_CAL \
+	(e_data_cal_get_type ())
+#define E_DATA_CAL(obj) \
+	(G_TYPE_CHECK_INSTANCE_CAST \
+	((obj), E_TYPE_DATA_CAL, EDataCal))
+#define E_DATA_CAL_CLASS(cls) \
+	(G_TYPE_CHECK_CLASS_CAST \
+	((cls), E_TYPE_DATA_CAL, EDataCalClass))
+#define E_IS_DATA_CAL(obj) \
+	(G_TYPE_CHECK_INSTANCE_TYPE \
+	((obj), E_TYPE_DATA_CAL))
+#define E_IS_DATA_CAL_CLASS(cls) \
+	(G_TYPE_CHECK_CLASS_TYPE \
+	((cls), E_TYPE_DATA_CAL))
+#define E_DATA_CAL_GET_CLASS(obj) \
+	(G_TYPE_INSTANCE_GET_CLASS \
+	((obj), E_TYPE_DATA_CAL, EDataCalClass))
 
 /**
  * E_DATA_CAL_ERROR:
@@ -49,27 +56,7 @@ GQuark e_data_cal_error_quark (void);
  **/
 #define E_DATA_CAL_ERROR e_data_cal_error_quark ()
 
-/**
- * e_data_cal_create_error:
- * @status: #EDataCalStatus code
- * @custom_msg: Custom message to use for the error. When NULL,
- *              then uses a default message based on the @status code.
- *
- * Returns: NULL, when the @status is Success,
- *          or a newly allocated GError, which should be freed
- *          with g_error_free() call.
- **/
-GError *e_data_cal_create_error (EDataCalCallStatus status, const gchar *custom_msg);
-
-/**
- * e_data_cal_create_error_fmt:
- *
- * Similar as e_data_cal_create_error(), only here, instead of custom_msg,
- * is used a printf() format to create a custom_msg for the error.
- **/
-GError *e_data_cal_create_error_fmt (EDataCalCallStatus status, const gchar *custom_msg_fmt, ...) G_GNUC_PRINTF (2, 3);
-
-const gchar *e_data_cal_status_to_string (EDataCalCallStatus status);
+G_BEGIN_DECLS
 
 /**
  * e_return_data_cal_error_if_fail:
@@ -128,39 +115,118 @@ struct _EDataCalClass {
 	GObjectClass parent_class;
 };
 
-GType e_data_cal_get_type (void);
+GQuark		e_data_cal_error_quark		(void);
+GError *	e_data_cal_create_error		(EDataCalCallStatus status,
+						 const gchar *custom_msg);
+GError *	e_data_cal_create_error_fmt	(EDataCalCallStatus status,
+						 const gchar *custom_msg_fmt,
+						 ...) G_GNUC_PRINTF (2, 3);
+const gchar *	e_data_cal_status_to_string	(EDataCalCallStatus status);
 
-EDataCal *	e_data_cal_new					(struct _ECalBackend *backend);
+GType		e_data_cal_get_type		(void) G_GNUC_CONST;
+EDataCal *	e_data_cal_new			(struct _ECalBackend *backend);
 struct _ECalBackend *
-		e_data_cal_get_backend				(EDataCal *cal);
-guint		e_data_cal_register_gdbus_object		(EDataCal *cal, GDBusConnection *connection, const gchar *object_path, GError **error);
-
-void		e_data_cal_respond_open				(EDataCal *cal, guint32 opid, GError *error);
-void		e_data_cal_respond_remove			(EDataCal *cal, guint32 opid, GError *error);
-void		e_data_cal_respond_refresh			(EDataCal *cal, guint32 opid, GError *error);
-void		e_data_cal_respond_get_backend_property		(EDataCal *cal, guint32 opid, GError *error, const gchar *prop_value);
-void		e_data_cal_respond_set_backend_property		(EDataCal *cal, guint32 opid, GError *error);
-void		e_data_cal_respond_get_object			(EDataCal *cal, guint32 opid, GError *error, const gchar *object);
-void		e_data_cal_respond_get_object_list		(EDataCal *cal, guint32 opid, GError *error, const GSList *objects);
-void		e_data_cal_respond_get_free_busy		(EDataCal *cal, guint32 opid, GError *error);
-void		e_data_cal_respond_create_objects		(EDataCal *cal, guint32 opid, GError *error, const GSList *uids, /*const */ GSList *new_components);
-void		e_data_cal_respond_modify_objects		(EDataCal *cal, guint32 opid, GError *error, /* const */ GSList *old_components, /* const */ GSList *new_components);
-void		e_data_cal_respond_remove_objects		(EDataCal *cal, guint32 opid, GError *error, const GSList *ids, /* const */ GSList *old_components, /* const */ GSList *new_components);
-void		e_data_cal_respond_receive_objects		(EDataCal *cal, guint32 opid, GError *error);
-void		e_data_cal_respond_send_objects			(EDataCal *cal, guint32 opid, GError *error, const GSList *users, const gchar *calobj);
-void		e_data_cal_respond_get_attachment_uris		(EDataCal *cal, guint32 opid, GError *error, const GSList *attachment_uris);
-void		e_data_cal_respond_discard_alarm		(EDataCal *cal, guint32 opid, GError *error);
-void		e_data_cal_respond_get_view			(EDataCal *cal, guint32 opid, GError *error, const gchar *view_path);
-void		e_data_cal_respond_get_timezone			(EDataCal *cal, guint32 opid, GError *error, const gchar *tzobject);
-void		e_data_cal_respond_add_timezone			(EDataCal *cal, guint32 opid, GError *error);
-
-void		e_data_cal_report_error				(EDataCal *cal, const gchar *message);
-void		e_data_cal_report_readonly			(EDataCal *cal, gboolean is_readonly);
-void		e_data_cal_report_online			(EDataCal *cal, gboolean is_online);
-void		e_data_cal_report_opened			(EDataCal *cal, const GError *error);
-void		e_data_cal_report_free_busy_data		(EDataCal *cal, const GSList *freebusy);
-void		e_data_cal_report_backend_property_changed	(EDataCal *cal, const gchar *prop_name, const gchar *prop_value);
+		e_data_cal_get_backend		(EDataCal *cal);
+guint		e_data_cal_register_gdbus_object
+						(EDataCal *cal,
+						 GDBusConnection *connection,
+						 const gchar *object_path,
+						 GError **error);
+void		e_data_cal_respond_open		(EDataCal *cal,
+						 guint32 opid,
+						 GError *error);
+void		e_data_cal_respond_remove	(EDataCal *cal,
+						 guint32 opid,
+						 GError *error);
+void		e_data_cal_respond_refresh	(EDataCal *cal,
+						 guint32 opid,
+						 GError *error);
+void		e_data_cal_respond_get_backend_property
+						(EDataCal *cal,
+						 guint32 opid,
+						 GError *error,
+						 const gchar *prop_value);
+void		e_data_cal_respond_set_backend_property
+						(EDataCal *cal,
+						 guint32 opid,
+						 GError *error);
+void		e_data_cal_respond_get_object	(EDataCal *cal,
+						 guint32 opid,
+						 GError *error,
+						 const gchar *object);
+void		e_data_cal_respond_get_object_list
+						(EDataCal *cal,
+						 guint32 opid,
+						 GError *error,
+						 const GSList *objects);
+void		e_data_cal_respond_get_free_busy
+						(EDataCal *cal,
+						 guint32 opid,
+						 GError *error);
+void		e_data_cal_respond_create_objects
+						(EDataCal *cal,
+						 guint32 opid,
+						 GError *error,
+						 const GSList *uids,
+						 GSList *new_components);
+void		e_data_cal_respond_modify_objects
+						(EDataCal *cal,
+						 guint32 opid,
+						 GError *error,
+						 GSList *old_components,
+						 GSList *new_components);
+void		e_data_cal_respond_remove_objects
+						(EDataCal *cal,
+						 guint32 opid,
+						 GError *error,
+						 const GSList *ids,
+						 GSList *old_components,
+						 GSList *new_components);
+void		e_data_cal_respond_receive_objects
+						(EDataCal *cal,
+						 guint32 opid,
+						 GError *error);
+void		e_data_cal_respond_send_objects	(EDataCal *cal,
+						 guint32 opid,
+						 GError *error,
+						 const GSList *users,
+						 const gchar *calobj);
+void		e_data_cal_respond_get_attachment_uris
+						(EDataCal *cal,
+						 guint32 opid,
+						 GError *error,
+						 const GSList *attachment_uris);
+void		e_data_cal_respond_discard_alarm
+						(EDataCal *cal,
+						 guint32 opid,
+						 GError *error);
+void		e_data_cal_respond_get_view	(EDataCal *cal,
+						 guint32 opid,
+						 GError *error,
+						 const gchar *view_path);
+void		e_data_cal_respond_get_timezone	(EDataCal *cal,
+						 guint32 opid,
+						 GError *error,
+						 const gchar *tzobject);
+void		e_data_cal_respond_add_timezone	(EDataCal *cal,
+						 guint32 opid,
+						 GError *error);
+void		e_data_cal_report_error		(EDataCal *cal,
+						 const gchar *message);
+void		e_data_cal_report_readonly	(EDataCal *cal,
+						 gboolean is_readonly);
+void		e_data_cal_report_online	(EDataCal *cal,
+						 gboolean is_online);
+void		e_data_cal_report_opened	(EDataCal *cal,
+						 const GError *error);
+void		e_data_cal_report_free_busy_data
+						(EDataCal *cal,
+						 const GSList *freebusy);
+void		e_data_cal_report_backend_property_changed
+						(EDataCal *cal,
+						 const gchar *prop_name,
+						 const gchar *prop_value);
 
 G_END_DECLS
 
-#endif
+#endif /* E_DATA_CAL_H */
diff --git a/docs/reference/calendar/libedata-cal/libedata-cal-sections.txt b/docs/reference/calendar/libedata-cal/libedata-cal-sections.txt
index fb149b8..958f7bd 100644
--- a/docs/reference/calendar/libedata-cal/libedata-cal-sections.txt
+++ b/docs/reference/calendar/libedata-cal/libedata-cal-sections.txt
@@ -299,6 +299,7 @@ E_IS_DATA_CAL
 E_TYPE_DATA_CAL
 E_DATA_CAL_CLASS
 E_IS_DATA_CAL_CLASS
+E_DATA_CAL_GET_CLASS
 E_TYPE_DATA_CAL_CALL_STATUS
 E_TYPE_DATA_CAL_MODE
 E_TYPE_DATA_CAL_OBJ_MOD_TYPE