From ede7ada7ba9d77eacd24ce567fa70e72815372c5 Mon Sep 17 00:00:00 2001 From: Matthew Barnes Date: Sun, 14 Mar 2010 12:33:37 -0400 Subject: [PATCH] Add "Since: 2.22" tags to the API documentation. Also create "Index of new symbols in 2.22" index pages in the table of contents pages. --- addressbook/libebook/e-book-query.c | 2 ++ addressbook/libebook/e-book-view.c | 2 ++ calendar/libecal/e-cal-time-util.c | 6 ++++ calendar/libecal/e-cal-view.c | 4 +++ camel/camel-arg.h | 36 ---------------------- camel/camel-mime-parser.c | 22 +++++++++++++ camel/camel-mime-part.c | 2 ++ camel/camel-net-utils.c | 15 +++++++++ camel/camel-offline-store.c | 5 +++ camel/camel-session.c | 17 ++++++++++ camel/camel-store.c | 4 +++ camel/camel-tcp-stream.c | 4 +++ .../addressbook/libebook/libebook-docs.sgml | 4 +++ .../libedata-book/libedata-book-docs.sgml | 4 +++ docs/reference/calendar/libecal/libecal-docs.sgml | 4 +++ .../calendar/libedata-cal/libedata-cal-docs.sgml | 4 +++ docs/reference/camel/camel-docs.sgml | 4 +++ .../libedataserver/libedataserver-docs.sgml | 4 +++ .../libedataserverui/libedataserverui-docs.sgml | 4 +++ libedataserver/e-time-utils.c | 9 ++++++ libedataserverui/e-cell-renderer-color.c | 5 +++ libedataserverui/e-cell-renderer-color.h | 5 +++ libedataserverui/e-source-combo-box.c | 14 +++++++++ libedataserverui/e-source-combo-box.h | 5 +++ 24 files changed, 149 insertions(+), 36 deletions(-) diff --git a/addressbook/libebook/e-book-query.c b/addressbook/libebook/e-book-query.c index 1f5bf19..0f6e0ae 100644 --- a/addressbook/libebook/e-book-query.c +++ b/addressbook/libebook/e-book-query.c @@ -211,6 +211,8 @@ e_book_query_field_test (EContactField field, * Creates a new #EBookQuery which tests @field for @value using the test @test. * * Return value: the new #EBookQuery + * + * Since: 2.22 **/ EBookQuery * e_book_query_vcard_field_test (const gchar *field, diff --git a/addressbook/libebook/e-book-view.c b/addressbook/libebook/e-book-view.c index 6b03068..e022e00 100644 --- a/addressbook/libebook/e-book-view.c +++ b/addressbook/libebook/e-book-view.c @@ -180,6 +180,8 @@ _e_book_view_new (EBook *book, DBusGProxy *view_proxy, GStaticRecMutex *view_pro * Returns the #EBook that this book view is monitoring. * * Return value: an #EBook. + * + * Since: 2.22 **/ EBook * e_book_view_get_book (EBookView *book_view) diff --git a/calendar/libecal/e-cal-time-util.c b/calendar/libecal/e-cal-time-util.c index f01076b..f74abfd 100644 --- a/calendar/libecal/e-cal-time-util.c +++ b/calendar/libecal/e-cal-time-util.c @@ -636,6 +636,8 @@ time_from_isodate (const gchar *str) * * Return value: The converted time as a struct tm. All fields will be * set properly except for tm.tm_yday. + * + * Since: 2.22 */ struct tm icaltimetype_to_tm (struct icaltimetype *itt) @@ -670,6 +672,8 @@ icaltimetype_to_tm (struct icaltimetype *itt) * * Return value: The converted time as a struct tm. All fields will be * set properly except for tm.tm_yday. + * + * Since: 2.22 **/ struct tm icaltimetype_to_tm_with_zone (struct icaltimetype *itt, @@ -700,6 +704,8 @@ icaltimetype_to_tm_with_zone (struct icaltimetype *itt, * Converts a struct tm into an icaltimetype. * * Return value: The converted time as an icaltimetype. + * + * Since: 2.22 */ struct icaltimetype tm_to_icaltimetype (struct tm *tm, gboolean is_date) diff --git a/calendar/libecal/e-cal-view.c b/calendar/libecal/e-cal-view.c index 5e8302f..123839a 100644 --- a/calendar/libecal/e-cal-view.c +++ b/calendar/libecal/e-cal-view.c @@ -387,6 +387,8 @@ _e_cal_view_new (ECal *client, DBusGProxy *view_proxy, GStaticRecMutex *connecti * Get the #ECal associated with this view. * * Return value: the associated client. + * + * Since: 2.22 */ ECal * e_cal_view_get_client (ECalView *view) @@ -401,6 +403,8 @@ e_cal_view_get_client (ECalView *view) * @view: A #ECalView object. * * Starts a live query to the calendar/tasks backend. + * + * Since: 2.22 */ void e_cal_view_start (ECalView *view) diff --git a/camel/camel-arg.h b/camel/camel-arg.h index be529f6..4159b92 100644 --- a/camel/camel-arg.h +++ b/camel/camel-arg.h @@ -72,48 +72,12 @@ struct _CamelArgGet { } u; }; -/** - * ca_object: - * - * Since: 2.26 - **/ #define ca_object u.ca_object - -/** - * ca_int: - * - * Since: 2.26 - **/ #define ca_int u.ca_int - -/** - * ca_double: - * - * Since: 2.26 - **/ #define ca_double u.ca_double - -/** - * ca_str: - * - * Since: 2.26 - **/ #define ca_str u.ca_str - -/** - * ca_ptr: - * - * Since: 2.26 - **/ #define ca_ptr u.ca_ptr -/** - * CAMEL_ARGV_MAX: - * - * Maximum no of args processed at any one time, not the max of all args. - * - * Since: 2.26 - **/ #define CAMEL_ARGV_MAX (20) struct _CamelArgV { diff --git a/camel/camel-mime-parser.c b/camel/camel-mime-parser.c index b527d19..2b72275 100644 --- a/camel/camel-mime-parser.c +++ b/camel/camel-mime-parser.c @@ -262,6 +262,8 @@ camel_mime_parser_new (void) * * Return value: An id that may be passed to filter_remove() to remove * the filter, or -1 if the operation failed. + * + * Since: 2.22 **/ gint camel_mime_parser_filter_add(CamelMimeParser *m, CamelMimeFilter *mf) @@ -292,6 +294,8 @@ camel_mime_parser_filter_add(CamelMimeParser *m, CamelMimeFilter *mf) * * Remove a processing filter from the pipeline. There is no * restriction on the order the filters can be removed. + * + * Since: 2.22 **/ void camel_mime_parser_filter_remove(CamelMimeParser *m, gint id) @@ -347,6 +351,8 @@ camel_mime_parser_header(CamelMimeParser *m, const gchar *name, gint *offset) * * Return value: The raw headers, or NULL if there are no headers * defined for the current part or state. These are READ ONLY. + * + * Since: 2.22 **/ struct _camel_header_raw * camel_mime_parser_headers_raw(CamelMimeParser *m) @@ -378,6 +384,8 @@ byte_array_to_string(GByteArray *array) * Can only be used when the state is CAMEL_MIME_PARSER_STATE_MULTIPART_END. * * Return value: The preface text, or NULL if there wasn't any. + * + * Since: 2.22 **/ const gchar * camel_mime_parser_preface(CamelMimeParser *m) @@ -399,6 +407,8 @@ camel_mime_parser_preface(CamelMimeParser *m) * CAMEL_MIME_PARSER_STATE_MULTIPART_END. * * Return value: The postface text, or NULL if there wasn't any. + * + * Since: 2.22 **/ const gchar * camel_mime_parser_postface(CamelMimeParser *m) @@ -423,6 +433,8 @@ camel_mime_parser_postface(CamelMimeParser *m) * state, or any deeper state. * * Return value: The From line, or NULL if called out of context. + * + * Since: 2.22 **/ const gchar * camel_mime_parser_from_line(CamelMimeParser *m) @@ -698,6 +710,8 @@ camel_mime_parser_read (CamelMimeParser *parser, const gchar **databuffer, gint * the respective current state). * * Return value: See above. + * + * Since: 2.22 **/ off_t camel_mime_parser_tell (CamelMimeParser *parser) @@ -717,6 +731,8 @@ camel_mime_parser_tell (CamelMimeParser *parser) * * Return value: The header start position, or -1 if * no headers were scanned in the current state. + * + * Since: 2.22 **/ off_t camel_mime_parser_tell_start_headers (CamelMimeParser *parser) @@ -735,6 +751,8 @@ camel_mime_parser_tell_start_headers (CamelMimeParser *parser) * * Return value: The start of the from line, or -1 if there * was no From line, or From lines are not being scanned. + * + * Since: 2.22 **/ off_t camel_mime_parser_tell_start_from (CamelMimeParser *parser) @@ -753,6 +771,8 @@ camel_mime_parser_tell_start_from (CamelMimeParser *parser) * * Return value: The start of the boundary, or -1 if there * was no boundary encountered yet. + * + * Since: 2.22 **/ off_t camel_mime_parser_tell_start_boundary(CamelMimeParser *parser) @@ -778,6 +798,8 @@ camel_mime_parser_tell_start_boundary(CamelMimeParser *parser) * Return value: The new seek offset, or -1 on * an error (for example, trying to seek on a non-seekable * stream or file descriptor). + * + * Since: 2.22 **/ off_t camel_mime_parser_seek(CamelMimeParser *parser, off_t offset, gint whence) diff --git a/camel/camel-mime-part.c b/camel/camel-mime-part.c index 6677179..f9f3322 100644 --- a/camel/camel-mime-part.c +++ b/camel/camel-mime-part.c @@ -1102,6 +1102,8 @@ camel_mime_part_set_content (CamelMimePart *mime_part, * Get the decoded size of the MIME part's content. * * Returns: the size of the MIME part's content in bytes. + * + * Since: 2.22 **/ gsize camel_mime_part_get_content_size (CamelMimePart *mime_part) diff --git a/camel/camel-net-utils.c b/camel/camel-net-utils.c index 49324cf..3ca1ae1 100644 --- a/camel/camel-net-utils.c +++ b/camel/camel-net-utils.c @@ -659,6 +659,11 @@ cs_getaddrinfo(gpointer data) } #endif /* NEED_ADDRINFO */ +/** + * camel_getaddrinfo: + * + * Since: 2.22 + **/ struct addrinfo * camel_getaddrinfo(const gchar *name, const gchar *service, const struct addrinfo *hints, CamelException *ex) { @@ -710,6 +715,11 @@ camel_getaddrinfo(const gchar *name, const gchar *service, const struct addrinfo return res; } +/** + * camel_freeaddrinfo: + * + * Since: 2.22 + **/ void camel_freeaddrinfo(struct addrinfo *host) { @@ -792,6 +802,11 @@ cs_getnameinfo(gpointer data) } #endif +/** + * camel_getnameinfo: + * + * Since: 2.22 + **/ gint camel_getnameinfo(const struct sockaddr *sa, socklen_t salen, gchar **host, gchar **serv, gint flags, CamelException *ex) { diff --git a/camel/camel-offline-store.c b/camel/camel-offline-store.c index 3a73a60..5cf2681 100644 --- a/camel/camel-offline-store.c +++ b/camel/camel-offline-store.c @@ -176,6 +176,11 @@ camel_offline_store_set_network_state (CamelOfflineStore *store, gint state, Cam store->state = state; } +/** + * camel_offline_store_prepare_for_offline: + * + * Since: 2.22 + **/ void camel_offline_store_prepare_for_offline (CamelOfflineStore *store, CamelException *ex) { diff --git a/camel/camel-session.c b/camel/camel-session.c index e047e26..5b626ac 100644 --- a/camel/camel-session.c +++ b/camel/camel-session.c @@ -431,6 +431,11 @@ camel_session_alert_user (CamelSession *session, CamelSessionAlertType type, return CS_CLASS (session)->alert_user (session, type, prompt, cancel); } +/** + * camel_session_lookup_addressbook: + * + * Since: 2.22 + **/ gboolean camel_session_lookup_addressbook (CamelSession *session, const gchar *name) { @@ -450,6 +455,8 @@ camel_session_lookup_addressbook (CamelSession *session, const gchar *name) * string contains markup tags. Use g_free() to free it. * * Returns: a newly-allocated password prompt string + * + * Since: 2.22 **/ gchar * camel_session_build_password_prompt (const gchar *type, @@ -778,6 +785,11 @@ camel_session_set_network_state (CamelSession *session, session->network_state = network_state; } +/** + * camel_session_set_junk_headers: + * + * Since: 2.22 + **/ void camel_session_set_junk_headers (CamelSession *session, const gchar **headers, @@ -800,6 +812,11 @@ camel_session_set_junk_headers (CamelSession *session, } } +/** + * camel_session_get_junk_headers: + * + * Since: 2.22 + **/ const GHashTable * camel_session_get_junk_headers (CamelSession *session) { diff --git a/camel/camel-store.c b/camel/camel-store.c index 54ccac2..b8aa1d8 100644 --- a/camel/camel-store.c +++ b/camel/camel-store.c @@ -990,6 +990,8 @@ camel_folder_info_free (CamelFolderInfo *fi) * camel_folder_info_new: * * Return value: a new empty CamelFolderInfo instance + * + * Since: 2.22 **/ CamelFolderInfo * camel_folder_info_new (void) @@ -1381,6 +1383,8 @@ can_refresh_folder (CamelStore *store, CamelFolderInfo *info, CamelException *ex * Default behavior is that all Inbox folders are intended to be refreshed. * * Returns: whether folder should be checked for new mails + * + * Since: 2.22 **/ gboolean camel_store_can_refresh_folder (CamelStore *store, CamelFolderInfo *info, CamelException *ex) diff --git a/camel/camel-tcp-stream.c b/camel/camel-tcp-stream.c index acc817b..9584806 100644 --- a/camel/camel-tcp-stream.c +++ b/camel/camel-tcp-stream.c @@ -170,6 +170,8 @@ tcp_get_local_address (CamelTcpStream *stream, socklen_t *len) * * Returns: the stream's local address (which must be freed with * #g_free) if the stream is connected, or %NULL if not + * + * Since: 2.22 **/ struct sockaddr * camel_tcp_stream_get_local_address (CamelTcpStream *stream, socklen_t *len) @@ -196,6 +198,8 @@ tcp_get_remote_address (CamelTcpStream *stream, socklen_t *len) * * Returns: the stream's remote address (which must be freed with * #g_free) if the stream is connected, or %NULL if not. + * + * Since: 2.22 **/ struct sockaddr * camel_tcp_stream_get_remote_address (CamelTcpStream *stream, socklen_t *len) diff --git a/docs/reference/addressbook/libebook/libebook-docs.sgml b/docs/reference/addressbook/libebook/libebook-docs.sgml index 4cdef80..91ef5ec 100644 --- a/docs/reference/addressbook/libebook/libebook-docs.sgml +++ b/docs/reference/addressbook/libebook/libebook-docs.sgml @@ -41,4 +41,8 @@ Index of new symbols in 2.24 + + Index of new symbols in 2.22 + + diff --git a/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml b/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml index 352df4a..4ad023e 100644 --- a/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml +++ b/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml @@ -43,4 +43,8 @@ Index of new symbols in 2.24 + + Index of new symbols in 2.22 + + diff --git a/docs/reference/calendar/libecal/libecal-docs.sgml b/docs/reference/calendar/libecal/libecal-docs.sgml index f78d5d3..f8b8554 100644 --- a/docs/reference/calendar/libecal/libecal-docs.sgml +++ b/docs/reference/calendar/libecal/libecal-docs.sgml @@ -41,4 +41,8 @@ Index of new symbols in 2.24 + + Index of new symbols in 2.22 + + diff --git a/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml b/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml index 0b8146b..619e4b4 100644 --- a/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml +++ b/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml @@ -44,4 +44,8 @@ Index of new symbols in 2.24 + + Index of new symbols in 2.22 + + diff --git a/docs/reference/camel/camel-docs.sgml b/docs/reference/camel/camel-docs.sgml index 9ea72d2..eb70680 100644 --- a/docs/reference/camel/camel-docs.sgml +++ b/docs/reference/camel/camel-docs.sgml @@ -347,5 +347,9 @@ Index of new symbols in 2.24 + + Index of new symbols in 2.22 + + diff --git a/docs/reference/libedataserver/libedataserver-docs.sgml b/docs/reference/libedataserver/libedataserver-docs.sgml index b680d14..ca3eb9f 100644 --- a/docs/reference/libedataserver/libedataserver-docs.sgml +++ b/docs/reference/libedataserver/libedataserver-docs.sgml @@ -55,4 +55,8 @@ Index of new symbols in 2.24 + + Index of new symbols in 2.22 + + diff --git a/docs/reference/libedataserverui/libedataserverui-docs.sgml b/docs/reference/libedataserverui/libedataserverui-docs.sgml index 2d6d5cd..4014291 100644 --- a/docs/reference/libedataserverui/libedataserverui-docs.sgml +++ b/docs/reference/libedataserverui/libedataserverui-docs.sgml @@ -50,4 +50,8 @@ Index of new symbols in 2.24 + + Index of new symbols in 2.22 + + diff --git a/libedataserver/e-time-utils.c b/libedataserver/e-time-utils.c index 19db08d..0935daa 100644 --- a/libedataserver/e-time-utils.c +++ b/libedataserver/e-time-utils.c @@ -1592,6 +1592,8 @@ has_correct_date (const struct tm *value) * Returns: E_TIME_PARSE_OK if the string was successfully parsed, * E_TIME_PARSE_NONE if the string was empty, or * E_TIME_PARSE_INVALID if the string could not be parsed. + * + * Since: 2.22 */ ETimeParseStatus e_time_parse_date_and_time_ex (const gchar *value, @@ -1741,6 +1743,8 @@ e_time_parse_date_and_time (const gchar *value, * * Returns: An #ETimeParseStatus result code indicating whether * @value was an empty string, a valid date, or an invalid date. + * + * Since: 2.22 **/ ETimeParseStatus e_time_parse_date_ex (const gchar *value, struct tm *result, gboolean *two_digit_year) @@ -2021,6 +2025,11 @@ static gint _e_string_replace(gchar **str, const gchar *old, const gchar *new) } #endif +/** + * e_time_get_d_fmt_with_4digit_year: + * + * Since: 2.22 + **/ gchar * e_time_get_d_fmt_with_4digit_year (void) { diff --git a/libedataserverui/e-cell-renderer-color.c b/libedataserverui/e-cell-renderer-color.c index 2343a16..65e73a6 100644 --- a/libedataserverui/e-cell-renderer-color.c +++ b/libedataserverui/e-cell-renderer-color.c @@ -233,6 +233,11 @@ e_cell_renderer_color_init (ECellRendererColor *cellcolor) g_object_set (cellcolor, "xpad", 4, NULL); } +/** + * e_cell_renderer_color_new: + * + * Since: 2.22 + **/ GtkCellRenderer * e_cell_renderer_color_new (void) { diff --git a/libedataserverui/e-cell-renderer-color.h b/libedataserverui/e-cell-renderer-color.h index b8e0c8a..a6cd6a4 100644 --- a/libedataserverui/e-cell-renderer-color.h +++ b/libedataserverui/e-cell-renderer-color.h @@ -47,6 +47,11 @@ typedef struct _ECellRendererColor ECellRendererColor; typedef struct _ECellRendererColorClass ECellRendererColorClass; typedef struct _ECellRendererColorPrivate ECellRendererColorPrivate; +/** + * ECellRendererColor: + * + * Since: 2.22 + **/ struct _ECellRendererColor { GtkCellRenderer parent; ECellRendererColorPrivate *priv; diff --git a/libedataserverui/e-source-combo-box.c b/libedataserverui/e-source-combo-box.c index 04f365f..60d65e2 100644 --- a/libedataserverui/e-source-combo-box.c +++ b/libedataserverui/e-source-combo-box.c @@ -347,6 +347,8 @@ e_source_combo_box_init (ESourceComboBox *source_combo_box) * from the provided #ESourceList. * * Returns: a new #ESourceComboBox + * + * Since: 2.22 **/ GtkWidget * e_source_combo_box_new (ESourceList *source_list) @@ -366,6 +368,8 @@ e_source_combo_box_new (ESourceList *source_list) * @source_combo_box. * * Returns: an #ESourceList + * + * Since: 2.22 **/ ESourceList * e_source_combo_box_get_source_list (ESourceComboBox *source_combo_box) @@ -382,6 +386,8 @@ e_source_combo_box_get_source_list (ESourceComboBox *source_combo_box) * * Sets the source list used by @source_combo_box to be @source_list. This * causes the contents of @source_combo_box to be regenerated. + * + * Since: 2.22 **/ void e_source_combo_box_set_source_list (ESourceComboBox *source_combo_box, @@ -427,6 +433,8 @@ e_source_combo_box_set_source_list (ESourceComboBox *source_combo_box, * if there is no active item. * * Returns: an #ESource or %NULL + * + * Since: 2.22 **/ ESource * e_source_combo_box_get_active (ESourceComboBox *source_combo_box) @@ -455,6 +463,8 @@ e_source_combo_box_get_active (ESourceComboBox *source_combo_box) * @source: an #ESource * * Sets the active item to the one corresponding to @source. + * + * Since: 2.22 **/ void e_source_combo_box_set_active (ESourceComboBox *source_combo_box, @@ -475,6 +485,8 @@ e_source_combo_box_set_active (ESourceComboBox *source_combo_box, * active item, or %NULL if there is no active item. * * Returns: a unique ID string or %NULL + * + * Since: 2.22 **/ const gchar * e_source_combo_box_get_active_uid (ESourceComboBox *source_combo_box) @@ -496,6 +508,8 @@ e_source_combo_box_get_active_uid (ESourceComboBox *source_combo_box) * @uid: a unique ID of an #ESource * * Sets the active item to the one corresponding to @uid. + * + * Since: 2.22 **/ void e_source_combo_box_set_active_uid (ESourceComboBox *source_combo_box, diff --git a/libedataserverui/e-source-combo-box.h b/libedataserverui/e-source-combo-box.h index e43ac8e..60c73f7 100644 --- a/libedataserverui/e-source-combo-box.h +++ b/libedataserverui/e-source-combo-box.h @@ -46,6 +46,11 @@ typedef struct _ESourceComboBox ESourceComboBox; typedef struct _ESourceComboBoxClass ESourceComboBoxClass; typedef struct _ESourceComboBoxPrivate ESourceComboBoxPrivate; +/** + * ESourceComboBox: + * + * Since: 2.22 + **/ struct _ESourceComboBox { GtkComboBox parent; -- 2.7.4