GNOME.org
 

[evolution-data-server] Add "Since: 1.12" tags to the API documentation.

commit eb8212a555fcb7ad60a3b873a61a1bdd3fb5bcbe
Author: Matthew Barnes <mbarnes redhat com>
Date:   Sun Mar 14 13:07:07 2010 -0400

    Add "Since: 1.12" tags to the API documentation.
    
    Also create "Index of new symbols in 1.12" index pages in the table
    of contents pages.

 addressbook/libebook/e-contact.c                   |    2 ++
 addressbook/libebook/e-contact.h                   |    5 +++++
 addressbook/libebook/e-vcard.c                     |    2 +-
 addressbook/libebook/e-vcard.h                     |    7 +++++++
 addressbook/libedata-book/e-book-backend.c         |    2 ++
 .../addressbook/libebook/libebook-docs.sgml        |    4 ++++
 .../addressbook/libebook/libebook-sections.txt     |    2 +-
 .../libedata-book/libedata-book-docs.sgml          |    4 ++++
 docs/reference/calendar/libecal/libecal-docs.sgml  |    4 ++++
 .../calendar/libedata-cal/libedata-cal-docs.sgml   |    4 ++++
 .../libedataserver/libedataserver-docs.sgml        |    4 ++++
 .../libedataserverui/libedataserverui-docs.sgml    |    4 ++++
 libedataserver/e-flag.c                            |   14 ++++++++++++++
 libedataserver/e-flag.h                            |    5 +++++
 libedataserver/e-source-group.c                    |   15 +++++++++++++++
 libedataserver/e-source.c                          |    5 +++++
 16 files changed, 81 insertions(+), 2 deletions(-)
---
diff --git a/addressbook/libebook/e-contact.c b/addressbook/libebook/e-contact.c
index 875588e..8eee63e 100644
--- a/addressbook/libebook/e-contact.c
+++ b/addressbook/libebook/e-contact.c
@@ -2018,6 +2018,8 @@ E_CONTACT_DEFINE_BOXED_TYPE (e_contact_photo, "EContactPhoto")
  * @geo: an #EContactGeo
  *
  * Frees the @geo struct and its contents.
+ *
+ * Since: 1.12
  **/
 void
 e_contact_geo_free (EContactGeo *geo)
diff --git a/addressbook/libebook/e-contact.h b/addressbook/libebook/e-contact.h
index 5f63eb8..3eafa42 100644
--- a/addressbook/libebook/e-contact.h
+++ b/addressbook/libebook/e-contact.h
@@ -232,6 +232,11 @@ typedef struct {
 	gchar *suffixes;
 } EContactName;
 
+/**
+ * EContactGeo:
+ *
+ * Since: 1.12
+ **/
 typedef struct {
 	gdouble latitude;
 	gdouble longitude;
diff --git a/addressbook/libebook/e-vcard.c b/addressbook/libebook/e-vcard.c
index daea606..fedea5e 100644
--- a/addressbook/libebook/e-vcard.c
+++ b/addressbook/libebook/e-vcard.c
@@ -1333,7 +1333,7 @@ e_vcard_attribute_remove_value (EVCardAttribute *attr, const gchar *s)
  *
  * Removes the parameter @param_name from the attribute @attr.
  *
- * Since 1.11.3.
+ * Since: 1.12
  */
 void
 e_vcard_attribute_remove_param (EVCardAttribute *attr, const gchar *param_name)
diff --git a/addressbook/libebook/e-vcard.h b/addressbook/libebook/e-vcard.h
index 8623c88..6bc54a4 100644
--- a/addressbook/libebook/e-vcard.h
+++ b/addressbook/libebook/e-vcard.h
@@ -36,7 +36,14 @@ G_BEGIN_DECLS
 #define EVC_ENCODING        "ENCODING"
 #define EVC_FBURL           "FBURL"
 #define EVC_FN              "FN"
+
+/**
+ * EVC_GEO:
+ *
+ * Since: 1.12
+ **/
 #define EVC_GEO		    "GEO"
+
 #define EVC_ICSCALENDAR     "ICSCALENDAR" /* XXX should this be X-EVOLUTION-ICSCALENDAR? */
 #define EVC_KEY             "KEY"
 #define EVC_LABEL           "LABEL"
diff --git a/addressbook/libedata-book/e-book-backend.c b/addressbook/libedata-book/e-book-backend.c
index 729c21e..e4ae1e0 100644
--- a/addressbook/libedata-book/e-book-backend.c
+++ b/addressbook/libedata-book/e-book-backend.c
@@ -746,6 +746,8 @@ e_book_backend_set_mode (EBookBackend *backend,
  * Write all pending data to disk.  This is only required under special
  * circumstances (for example before a live backup) and should not be used in
  * normal use.
+ *
+ * Since: 1.12
  */
 void
 e_book_backend_sync (EBookBackend *backend)
diff --git a/docs/reference/addressbook/libebook/libebook-docs.sgml b/docs/reference/addressbook/libebook/libebook-docs.sgml
index 91ef5ec..415e2c5 100644
--- a/docs/reference/addressbook/libebook/libebook-docs.sgml
+++ b/docs/reference/addressbook/libebook/libebook-docs.sgml
@@ -45,4 +45,8 @@
     <title>Index of new symbols in 2.22</title>
     <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
   </index>
+  <index id="api-index-1.12" role="1.12">
+    <title>Index of new symbols in 1.12</title>
+    <xi:include href="xml/api-index-1.12.xml"><xi:fallback /></xi:include>
+  </index>
 </book>
diff --git a/docs/reference/addressbook/libebook/libebook-sections.txt b/docs/reference/addressbook/libebook/libebook-sections.txt
index e3301cb..fafbc5b 100644
--- a/docs/reference/addressbook/libebook/libebook-sections.txt
+++ b/docs/reference/addressbook/libebook/libebook-sections.txt
@@ -147,12 +147,12 @@ e_contact_get_type
 e_contact_address_get_type
 e_contact_cert_get_type
 e_contact_photo_get_type
-e_contact_geo_get_type
 e_contact_name_get_type
 e_contact_date_get_type
 EContactPhotoType
 <SUBSECTION Private>
 EContactPrivate
+e_contact_geo_get_type
 </SECTION>
 
 <SECTION>
diff --git a/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml b/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml
index 4ad023e..cd4d074 100644
--- a/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml
+++ b/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml
@@ -47,4 +47,8 @@
     <title>Index of new symbols in 2.22</title>
     <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
   </index>
+  <index id="api-index-1.12" role="1.12">
+    <title>Index of new symbols in 1.12</title>
+    <xi:include href="xml/api-index-1.12.xml"><xi:fallback /></xi:include>
+  </index>
 </book>
diff --git a/docs/reference/calendar/libecal/libecal-docs.sgml b/docs/reference/calendar/libecal/libecal-docs.sgml
index f8b8554..0d91d12 100644
--- a/docs/reference/calendar/libecal/libecal-docs.sgml
+++ b/docs/reference/calendar/libecal/libecal-docs.sgml
@@ -45,4 +45,8 @@
     <title>Index of new symbols in 2.22</title>
     <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
   </index>
+  <index id="api-index-1.12" role="1.12">
+    <title>Index of new symbols in 1.12</title>
+    <xi:include href="xml/api-index-1.12.xml"><xi:fallback /></xi:include>
+  </index>
 </book>
diff --git a/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml b/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml
index 619e4b4..fd01af1 100644
--- a/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml
+++ b/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml
@@ -48,4 +48,8 @@
     <title>Index of new symbols in 2.22</title>
     <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
   </index>
+  <index id="api-index-1.12" role="1.12">
+    <title>Index of new symbols in 1.12</title>
+    <xi:include href="xml/api-index-1.12.xml"><xi:fallback /></xi:include>
+  </index>
 </book>
diff --git a/docs/reference/libedataserver/libedataserver-docs.sgml b/docs/reference/libedataserver/libedataserver-docs.sgml
index ca3eb9f..016c4d6 100644
--- a/docs/reference/libedataserver/libedataserver-docs.sgml
+++ b/docs/reference/libedataserver/libedataserver-docs.sgml
@@ -59,4 +59,8 @@
     <title>Index of new symbols in 2.22</title>
     <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
   </index>
+  <index id="api-index-1.12" role="1.12">
+    <title>Index of new symbols in 1.12</title>
+    <xi:include href="xml/api-index-1.12.xml"><xi:fallback /></xi:include>
+  </index>
 </book>
diff --git a/docs/reference/libedataserverui/libedataserverui-docs.sgml b/docs/reference/libedataserverui/libedataserverui-docs.sgml
index 4014291..28cdf2e 100644
--- a/docs/reference/libedataserverui/libedataserverui-docs.sgml
+++ b/docs/reference/libedataserverui/libedataserverui-docs.sgml
@@ -54,4 +54,8 @@
     <title>Index of new symbols in 2.22</title>
     <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
   </index>
+  <index id="api-index-1.12" role="1.12">
+    <title>Index of new symbols in 1.12</title>
+    <xi:include href="xml/api-index-1.12.xml"><xi:fallback /></xi:include>
+  </index>
 </book>
diff --git a/libedataserver/e-flag.c b/libedataserver/e-flag.c
index 89358ca..2971018 100644
--- a/libedataserver/e-flag.c
+++ b/libedataserver/e-flag.c
@@ -31,6 +31,8 @@ struct _EFlag {
  * Creates a new #EFlag object.  It is initially unset.
  *
  * Returns: a new #EFlag
+ *
+ * Since: 1.12
  **/
 EFlag *
 e_flag_new (void)
@@ -52,6 +54,8 @@ e_flag_new (void)
  * Returns the state of @flag.
  *
  * Returns: %TRUE if @flag is set
+ *
+ * Since: 1.12
  **/
 gboolean
 e_flag_is_set (EFlag *flag)
@@ -74,6 +78,8 @@ e_flag_is_set (EFlag *flag)
  * Sets @flag.  All threads waiting on @flag are woken up.  Threads that
  * call e_flag_wait() or e_flag_timed_wait() once @flag is set will not
  * block at all.
+ *
+ * Since: 1.12
  **/
 void
 e_flag_set (EFlag *flag)
@@ -92,6 +98,8 @@ e_flag_set (EFlag *flag)
  *
  * Unsets @flag.  Subsequent calls to e_flag_wait() or e_flag_timed_wait()
  * will block until @flag is set.
+ *
+ * Since: 1.12
  **/
 void
 e_flag_clear (EFlag *flag)
@@ -109,6 +117,8 @@ e_flag_clear (EFlag *flag)
  *
  * Blocks until @flag is set.  If @flag is already set, the function returns
  * immediately.
+ *
+ * Since: 1.12
  **/
 void
 e_flag_wait (EFlag *flag)
@@ -136,6 +146,8 @@ e_flag_wait (EFlag *flag)
  * g_time_val_add() can be used.
  *
  * Returns: %TRUE if @flag is now set
+ *
+ * Since: 1.12
  **/
 gboolean
 e_flag_timed_wait (EFlag *flag, GTimeVal *abs_time)
@@ -159,6 +171,8 @@ e_flag_timed_wait (EFlag *flag, GTimeVal *abs_time)
  * @flag: an #EFlag
  *
  * Destroys @flag.
+ *
+ * Since: 1.12
  **/
 void
 e_flag_free (EFlag *flag)
diff --git a/libedataserver/e-flag.h b/libedataserver/e-flag.h
index 74f6e10..4bab8f2 100644
--- a/libedataserver/e-flag.h
+++ b/libedataserver/e-flag.h
@@ -27,6 +27,11 @@
 
 G_BEGIN_DECLS
 
+/**
+ * EFlag:
+ *
+ * Since: 1.12
+ **/
 typedef struct _EFlag EFlag;
 
 EFlag *		e_flag_new			(void);
diff --git a/libedataserver/e-source-group.c b/libedataserver/e-source-group.c
index fbd35b4..42306d7 100644
--- a/libedataserver/e-source-group.c
+++ b/libedataserver/e-source-group.c
@@ -889,6 +889,11 @@ e_source_group_xmlstr_equal (const gchar *a, const gchar *b)
 	return retval;
 }
 
+/**
+ * e_source_group_get_property:
+ *
+ * Since: 1.12
+ **/
 gchar *
 e_source_group_get_property (ESourceGroup *source_group,
 			     const gchar *property)
@@ -901,6 +906,11 @@ e_source_group_get_property (ESourceGroup *source_group,
 	return g_strdup (g_hash_table_lookup (priv->properties, property));
 }
 
+/**
+ * e_source_group_set_property:
+ *
+ * Since: 1.12
+ **/
 void
 e_source_group_set_property (ESourceGroup *source_group,
 			     const gchar *property,
@@ -919,6 +929,11 @@ e_source_group_set_property (ESourceGroup *source_group,
 	g_signal_emit (source_group, signals[CHANGED], 0);
 }
 
+/**
+ * e_source_group_foreach_property:
+ *
+ * Since: 1.12
+ **/
 void
 e_source_group_foreach_property (ESourceGroup *source_group, GHFunc func, gpointer data)
 {
diff --git a/libedataserver/e-source.c b/libedataserver/e-source.c
index 4291ff5..d9a7eb3 100644
--- a/libedataserver/e-source.c
+++ b/libedataserver/e-source.c
@@ -935,6 +935,11 @@ e_source_get_property (ESource *source,
 	return g_hash_table_lookup (priv->properties, property);
 }
 
+/**
+ * e_source_get_duped_property:
+ *
+ * Since: 1.12
+ **/
 gchar *
 e_source_get_duped_property (ESource *source, const gchar *property)
 {
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]