[evolution-data-server] Update user documentation about E_CAL/BOOK_DISABLE_DEPRECATED
- From: Milan Crha <mcrha src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evolution-data-server] Update user documentation about E_CAL/BOOK_DISABLE_DEPRECATED
- Date: Fri, 9 Jul 2010 14:19:46 +0000 (UTC)
commit 8ac70847243f8d3d1485683e039dc86db3b26ae7
Author: Milan Crha <mcrha redhat com>
Date: Fri Jul 9 16:18:57 2010 +0200
Update user documentation about E_CAL/BOOK_DISABLE_DEPRECATED
addressbook/libebook/e-book.c | 10 ++++++++++
calendar/libecal/e-cal.c | 8 ++++++++
docs/reference/addressbook/libebook/Makefile.am | 2 +-
.../addressbook/libedata-book/Makefile.am | 2 +-
docs/reference/calendar/libecal/Makefile.am | 2 +-
docs/reference/calendar/libedata-cal/Makefile.am | 2 +-
6 files changed, 22 insertions(+), 4 deletions(-)
---
diff --git a/addressbook/libebook/e-book.c b/addressbook/libebook/e-book.c
index 296fc65..d489253 100644
--- a/addressbook/libebook/e-book.c
+++ b/addressbook/libebook/e-book.c
@@ -20,6 +20,16 @@
* Author: Ross Burton <ross linux intel com>
*/
+/**
+ * SECTION:e-book
+ *
+ * The old asynchronous API was deprecated since 3.0 and is replaced with
+ * their equivalents with an _ex suffix, which has a detailed #GError
+ * structure in the asynchronous callback, instead of a status code only.
+ *
+ * As an example, e_book_async_open() is replaced by e_book_async_open_ex().
+ */
+
#include <config.h>
#include <unistd.h>
#include <string.h>
diff --git a/calendar/libecal/e-cal.c b/calendar/libecal/e-cal.c
index a419e60..6d28626 100644
--- a/calendar/libecal/e-cal.c
+++ b/calendar/libecal/e-cal.c
@@ -22,6 +22,14 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:e-cal
+ *
+ * The old signal "cal-opened" is deprecated since 3.0 and is replaced with
+ * its equivalent "cal_opened_ex", which has a detailed #GError structure
+ * as a parameter, instead of a status code only.
+ */
+
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
diff --git a/docs/reference/addressbook/libebook/Makefile.am b/docs/reference/addressbook/libebook/Makefile.am
index bf0e0ef..084b167 100644
--- a/docs/reference/addressbook/libebook/Makefile.am
+++ b/docs/reference/addressbook/libebook/Makefile.am
@@ -5,7 +5,7 @@ DOC_MODULE = libebook
DOC_MAIN_SGML_FILE = libebook-docs.sgml
# Extra options to supply to gtkdoc-scan
-SCAN_OPTIONS = --deprecated-guards="EDS_DISABLE_DEPRECATED"
+SCAN_OPTIONS = --deprecated-guards="EDS_DISABLE_DEPRECATED|E_BOOK_DISABLE_DEPRECATED"
# The directory containing the source code. Relative to $(srcdir).
DOC_SOURCE_DIR = $(top_srcdir)/addressbook/libebook
diff --git a/docs/reference/addressbook/libedata-book/Makefile.am b/docs/reference/addressbook/libedata-book/Makefile.am
index daa1752..ea5a38c 100644
--- a/docs/reference/addressbook/libedata-book/Makefile.am
+++ b/docs/reference/addressbook/libedata-book/Makefile.am
@@ -5,7 +5,7 @@ DOC_MODULE = libedata-book
DOC_MAIN_SGML_FILE = libedata-book-docs.sgml
# Extra options to supply to gtkdoc-scan
-SCAN_OPTIONS = --deprecated-guards="EDS_DISABLE_DEPRECATED"
+SCAN_OPTIONS = --deprecated-guards="EDS_DISABLE_DEPRECATED|E_BOOK_DISABLE_DEPRECATED"
# The directory containing the source code. Relative to $(srcdir).
DOC_SOURCE_DIR = $(top_srcdir)/addressbook/libedata-book
diff --git a/docs/reference/calendar/libecal/Makefile.am b/docs/reference/calendar/libecal/Makefile.am
index 1624e11..d988f39 100644
--- a/docs/reference/calendar/libecal/Makefile.am
+++ b/docs/reference/calendar/libecal/Makefile.am
@@ -5,7 +5,7 @@ DOC_MODULE = libecal
DOC_MAIN_SGML_FILE = libecal-docs.sgml
# Extra options to supply to gtkdoc-scan
-SCAN_OPTIONS = --deprecated-guards="EDS_DISABLE_DEPRECATED"
+SCAN_OPTIONS = --deprecated-guards="EDS_DISABLE_DEPRECATED|E_CAL_DISABLE_DEPRECATED"
# The directory containing the source code. Relative to $(srcdir).
DOC_SOURCE_DIR = $(top_srcdir)/calendar/libecal
diff --git a/docs/reference/calendar/libedata-cal/Makefile.am b/docs/reference/calendar/libedata-cal/Makefile.am
index 226edec..10ed038 100644
--- a/docs/reference/calendar/libedata-cal/Makefile.am
+++ b/docs/reference/calendar/libedata-cal/Makefile.am
@@ -9,7 +9,7 @@ HTML_IMAGES=
DOC_MAIN_SGML_FILE = libedata-cal-docs.sgml
# Extra options to supply to gtkdoc-scan
-SCAN_OPTIONS = --deprecated-guards="EDS_DISABLE_DEPRECATED"
+SCAN_OPTIONS = --deprecated-guards="EDS_DISABLE_DEPRECATED|E_CAL_DISABLE_DEPRECATED"
# The directory containing the source code. Relative to $(srcdir).
DOC_SOURCE_DIR = $(top_srcdir)/calendar/libedata-cal
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]