diff options
author | Matthew Barnes <mbarnes@redhat.com> | 2009-08-17 21:48:15 -0400 |
---|---|---|
committer | Matthew Barnes <mbarnes@redhat.com> | 2009-08-17 21:48:15 -0400 |
commit | 704ae00fc11b2e29f013b1496128ade016a89490 (patch) | |
tree | 72367cd275f3ab6420bfe9ee9e8153b993cbe31c | |
parent | dd46c649675c61e11d6cef1f17fd0afbabd47251 (diff) | |
download | evolution-data-server-704ae00fc11b2e29f013b1496128ade016a89490.tar.gz |
Fix build breakage in API documentation.
11 files changed, 285 insertions, 328 deletions
diff --git a/docs/reference/addressbook/libebook/libebook-docs.sgml b/docs/reference/addressbook/libebook/libebook-docs.sgml index 148949165..0f3459c06 100644 --- a/docs/reference/addressbook/libebook/libebook-docs.sgml +++ b/docs/reference/addressbook/libebook/libebook-docs.sgml @@ -9,11 +9,9 @@ <chapter> <title>Evolution-Data-Server Manual: Address Book Client (libebook)</title> <xi:include href="xml/e-book.xml"/> - <xi:include href="xml/e-book-listener.xml"/> <xi:include href="xml/e-book-query.xml"/> <xi:include href="xml/e-book-types.xml"/> <xi:include href="xml/e-book-view.xml"/> - <xi:include href="xml/e-book-view-listener.xml"/> <xi:include href="xml/e-vcard.xml"/> <xi:include href="xml/e-contact.xml"/> <xi:include href="xml/e-destination.xml"/> diff --git a/docs/reference/addressbook/libebook/libebook-sections.txt b/docs/reference/addressbook/libebook/libebook-sections.txt index b42d183b3..2aa860b5b 100644 --- a/docs/reference/addressbook/libebook/libebook-sections.txt +++ b/docs/reference/addressbook/libebook/libebook-sections.txt @@ -1,47 +1,4 @@ <SECTION> -<FILE>e-book-listener</FILE> -<TITLE>EBookListener</TITLE> -EBookListener -EBookListenerResponse -EBookListenerOperation -e_book_listener_new -e_book_listener_stop -<SUBSECTION Standard> -EBookListenerClass -E_BOOK_LISTENER -E_IS_BOOK_LISTENER -E_TYPE_BOOK_LISTENER -e_book_listener_get_type -E_BOOK_LISTENER_CLASS -E_IS_BOOK_LISTENER_CLASS -E_BOOK_LISTENER_GET_CLASS -<SUBSECTION Private> -EBookListenerPrivate -</SECTION> - -<SECTION> -<FILE>e-book-view-listener</FILE> -<TITLE>EBookViewListener</TITLE> -EBookViewListener -EBookViewListenerResponse -EBookViewListenerOperation -e_book_view_listener_new -e_book_view_listener_start -e_book_view_listener_stop -<SUBSECTION Standard> -EBookViewListenerClass -E_BOOK_VIEW_LISTENER -E_IS_BOOK_VIEW_LISTENER -E_TYPE_BOOK_VIEW_LISTENER -e_book_view_listener_get_type -E_BOOK_VIEW_LISTENER_CLASS -E_IS_BOOK_VIEW_LISTENER_CLASS -E_BOOK_VIEW_LISTENER_GET_CLASS -<SUBSECTION Private> -EBookViewListenerPrivate -</SECTION> - -<SECTION> <FILE>e-book-view</FILE> <TITLE>EBookView</TITLE> EBookView diff --git a/docs/reference/addressbook/libebook/libebook.types b/docs/reference/addressbook/libebook/libebook.types index 8bdb67f6f..4dd5f9faf 100644 --- a/docs/reference/addressbook/libebook/libebook.types +++ b/docs/reference/addressbook/libebook/libebook.types @@ -1,15 +1,11 @@ #include <libebook/e-book.h> -#include <libebook/e-book-listener.h> #include <libebook/e-book-view.h> -#include <libebook/e-book-view-listener.h> #include <libebook/e-contact.h> #include <libebook/e-destination.h> #include <libebook/e-vcard.h> e_book_get_type -e_book_listener_get_type e_book_view_get_type -e_book_view_listener_get_type e_contact_get_type e_destination_get_type e_vcard_get_type diff --git a/docs/reference/addressbook/libebook/tmpl/e-book-listener.sgml b/docs/reference/addressbook/libebook/tmpl/e-book-listener.sgml deleted file mode 100644 index 3c55168e5..000000000 --- a/docs/reference/addressbook/libebook/tmpl/e-book-listener.sgml +++ /dev/null @@ -1,89 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EBookListener - -<!-- ##### SECTION Short_Description ##### --> -Listens for call responses and event notifications from EBook objects. - -<!-- ##### SECTION Long_Description ##### --> -<para> -Exposes the Evolution:BookListener interface. Contrast with EBookViewListener. - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT EBookListener ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL EBookListener::response ##### --> -<para> - -</para> - -@ebooklistener: the object which received the signal. -@arg1: - -<!-- ##### STRUCT EBookListenerResponse ##### --> -<para> - -</para> - -@op: -@opid: -@status: -@book_view: -@list: -@msg: -@connected: -@writable: -@id: -@vcard: - -<!-- ##### ENUM EBookListenerOperation ##### --> -<para> - -</para> - -@OpenBookResponse: -@RemoveBookResponse: -@CreateContactResponse: -@RemoveContactResponse: -@ModifyContactResponse: -@GetContactResponse: -@GetContactListResponse: -@GetBookViewResponse: -@GetChangesResponse: -@AuthenticationResponse: -@GetSupportedFieldsResponse: -@GetRequiredFieldsResponse: -@GetSupportedAuthMethodsResponse: -@LinkStatusEvent: -@WritableStatusEvent: -@AuthRequiredEvent: -@ProgressEvent: - -<!-- ##### FUNCTION e_book_listener_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION e_book_listener_stop ##### --> -<para> - -</para> - -@listener: - - diff --git a/docs/reference/addressbook/libebook/tmpl/e-book-view-listener.sgml b/docs/reference/addressbook/libebook/tmpl/e-book-view-listener.sgml deleted file mode 100644 index b1cf2eb1c..000000000 --- a/docs/reference/addressbook/libebook/tmpl/e-book-view-listener.sgml +++ /dev/null @@ -1,80 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EBookViewListener - -<!-- ##### SECTION Short_Description ##### --> -Listens for call responses and event notifications from EBookView objects. - -<!-- ##### SECTION Long_Description ##### --> -<para> -Exposes the Evolution:BookViewListener interface. Contrast with the EBookListener. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -EBookListener -EBookTypes -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT EBookViewListener ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL EBookViewListener::response ##### --> -<para> - -</para> - -@ebookviewlistener: the object which received the signal. -@arg1: - -<!-- ##### STRUCT EBookViewListenerResponse ##### --> -<para> -Data sent back to the e-book object. -</para> - -@op: -@status: -@ids: -@contacts: -@message: - -<!-- ##### ENUM EBookViewListenerOperation ##### --> -<para> -Asynchronous events that are listened for. -</para> - -@ContactsAddedEvent: -@ContactsRemovedEvent: -@ContactsModifiedEvent: -@SequenceCompleteEvent: -@StatusMessageEvent: - -<!-- ##### FUNCTION e_book_view_listener_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION e_book_view_listener_start ##### --> -<para> - -</para> - -@listener: - - -<!-- ##### FUNCTION e_book_view_listener_stop ##### --> -<para> - -</para> - -@listener: - - diff --git a/docs/reference/addressbook/libebook/tmpl/e-book-view.sgml b/docs/reference/addressbook/libebook/tmpl/e-book-view.sgml index 495b37493..a5b68f5bd 100644 --- a/docs/reference/addressbook/libebook/tmpl/e-book-view.sgml +++ b/docs/reference/addressbook/libebook/tmpl/e-book-view.sgml @@ -71,16 +71,6 @@ Fired with a status message reporting the progress of the view. @ebookview: the object which received the signal. @arg1: a const char* message -<!-- ##### FUNCTION e_book_view_new ##### --> -<para> - -</para> - -@corba_book_view: -@listener: -@Returns: - - <!-- ##### FUNCTION e_book_view_start ##### --> <para> @@ -97,15 +87,6 @@ Fired with a status message reporting the progress of the view. @book_view: -<!-- ##### FUNCTION e_book_view_set_book ##### --> -<para> - -</para> - -@book_view: -@book: - - <!-- ##### FUNCTION e_book_view_get_book ##### --> <para> diff --git a/docs/reference/addressbook/libebook/tmpl/libebook-unused.sgml b/docs/reference/addressbook/libebook/tmpl/libebook-unused.sgml index 90ffd55e4..b93bb76c0 100644 --- a/docs/reference/addressbook/libebook/tmpl/libebook-unused.sgml +++ b/docs/reference/addressbook/libebook/tmpl/libebook-unused.sgml @@ -101,24 +101,113 @@ e-name-western-tables @fields: @closure: +<!-- ##### STRUCT EBookListener ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EBookListener::response ##### --> +<para> + +</para> + +@ebooklistener: the object which received the signal. +@arg1: + +<!-- ##### ENUM EBookListenerOperation ##### --> +<para> + +</para> + +@OpenBookResponse: +@RemoveBookResponse: +@CreateContactResponse: +@RemoveContactResponse: +@ModifyContactResponse: +@GetContactResponse: +@GetContactListResponse: +@GetBookViewResponse: +@GetChangesResponse: +@AuthenticationResponse: +@GetSupportedFieldsResponse: +@GetRequiredFieldsResponse: +@GetSupportedAuthMethodsResponse: +@LinkStatusEvent: +@WritableStatusEvent: +@AuthRequiredEvent: +@ProgressEvent: + <!-- ##### STRUCT EBookListenerPrivate ##### --> <para> </para> +<!-- ##### STRUCT EBookListenerResponse ##### --> +<para> + +</para> + +@op: +@opid: +@status: +@book_view: +@list: +@msg: +@connected: +@writable: +@id: +@vcard: + <!-- ##### STRUCT EBookPrivate ##### --> <para> </para> +<!-- ##### STRUCT EBookViewListener ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EBookViewListener::response ##### --> +<para> + +</para> + +@ebookviewlistener: the object which received the signal. +@arg1: + +<!-- ##### ENUM EBookViewListenerOperation ##### --> +<para> +Asynchronous events that are listened for. +</para> + +@ContactsAddedEvent: +@ContactsRemovedEvent: +@ContactsModifiedEvent: +@SequenceCompleteEvent: +@StatusMessageEvent: + <!-- ##### STRUCT EBookViewListenerPrivate ##### --> <para> </para> +<!-- ##### STRUCT EBookViewListenerResponse ##### --> +<para> +Data sent back to the e-book object. +</para> + +@op: +@status: +@ids: +@contacts: +@message: + <!-- ##### STRUCT EBookViewPrivate ##### --> <para> @@ -189,6 +278,20 @@ e-name-western-tables @error: @Returns: +<!-- ##### FUNCTION e_book_listener_new ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION e_book_listener_stop ##### --> +<para> + +</para> + +@listener: + <!-- ##### FUNCTION e_book_load_local_addressbook ##### --> <para> @@ -289,6 +392,44 @@ e-name-western-tables @error: @Returns: +<!-- ##### FUNCTION e_book_view_listener_new ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION e_book_view_listener_start ##### --> +<para> + +</para> + +@listener: + +<!-- ##### FUNCTION e_book_view_listener_stop ##### --> +<para> + +</para> + +@listener: + +<!-- ##### FUNCTION e_book_view_new ##### --> +<para> + +</para> + +@corba_book_view: +@listener: +@Returns: + +<!-- ##### FUNCTION e_book_view_set_book ##### --> +<para> + +</para> + +@book_view: +@book: + <!-- ##### FUNCTION e_contact_cert_get_type ##### --> <para> diff --git a/docs/reference/addressbook/libedata-book/tmpl/e-data-book-factory.sgml b/docs/reference/addressbook/libedata-book/tmpl/e-data-book-factory.sgml index cc23c5901..e7d4b8efa 100644 --- a/docs/reference/addressbook/libedata-book/tmpl/e-data-book-factory.sgml +++ b/docs/reference/addressbook/libedata-book/tmpl/e-data-book-factory.sgml @@ -22,61 +22,9 @@ EDataBookFactory </para> -@parent_object: +@parent: @priv: -<!-- ##### FUNCTION e_data_book_factory_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION e_data_book_factory_register_backend ##### --> -<para> - -</para> - -@factory: -@backend_factory: - - -<!-- ##### FUNCTION e_data_book_factory_get_n_backends ##### --> -<para> - -</para> - -@factory: -@Returns: - - -<!-- ##### FUNCTION e_data_book_factory_register_backends ##### --> -<para> - -</para> - -@factory: - - -<!-- ##### FUNCTION e_data_book_factory_dump_active_backends ##### --> -<para> - -</para> - -@factory: - - -<!-- ##### FUNCTION e_data_book_factory_activate ##### --> -<para> - -</para> - -@factory: -@iid: -@Returns: - - <!-- ##### FUNCTION e_data_book_factory_set_backend_mode ##### --> <para> diff --git a/docs/reference/addressbook/libedata-book/tmpl/e-data-book-view.sgml b/docs/reference/addressbook/libedata-book/tmpl/e-data-book-view.sgml index df651bb11..d310fbd8f 100644 --- a/docs/reference/addressbook/libedata-book/tmpl/e-data-book-view.sgml +++ b/docs/reference/addressbook/libedata-book/tmpl/e-data-book-view.sgml @@ -23,48 +23,70 @@ EDataBookView </para> -<!-- ##### FUNCTION e_data_book_view_new ##### --> +<!-- ##### SIGNAL EDataBookView::complete ##### --> <para> </para> -@backend: -@listener: -@card_query: -@card_sexp: -@max_results: -@Returns: +@edatabookview: the object which received the signal. +@arg1: +<!-- ##### SIGNAL EDataBookView::contacts-added ##### --> +<para> -<!-- ##### FUNCTION e_data_book_view_set_thresholds ##### --> +</para> + +@edatabookview: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EDataBookView::contacts-changed ##### --> <para> </para> -@book_view: -@minimum_grouping_threshold: -@maximum_grouping_threshold: +@edatabookview: the object which received the signal. +@arg1: +<!-- ##### SIGNAL EDataBookView::contacts-removed ##### --> +<para> -<!-- ##### FUNCTION e_data_book_view_get_card_query ##### --> +</para> + +@edatabookview: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EDataBookView::status-message ##### --> <para> </para> -@book_view: +@edatabookview: the object which received the signal. +@arg1: + +<!-- ##### FUNCTION e_data_book_view_new ##### --> +<para> + +</para> + +@book: +@path: +@card_query: +@card_sexp: +@max_results: @Returns: -<!-- ##### FUNCTION e_data_book_view_get_card_sexp ##### --> +<!-- ##### FUNCTION e_data_book_view_set_thresholds ##### --> <para> </para> @book_view: -@Returns: +@minimum_grouping_threshold: +@maximum_grouping_threshold: -<!-- ##### FUNCTION e_data_book_view_get_max_results ##### --> +<!-- ##### FUNCTION e_data_book_view_get_card_query ##### --> <para> </para> @@ -73,7 +95,7 @@ EDataBookView @Returns: -<!-- ##### FUNCTION e_data_book_view_get_backend ##### --> +<!-- ##### FUNCTION e_data_book_view_get_card_sexp ##### --> <para> </para> @@ -82,7 +104,7 @@ EDataBookView @Returns: -<!-- ##### FUNCTION e_data_book_view_get_listener ##### --> +<!-- ##### FUNCTION e_data_book_view_get_max_results ##### --> <para> </para> @@ -91,7 +113,7 @@ EDataBookView @Returns: -<!-- ##### FUNCTION e_data_book_view_get_mutex ##### --> +<!-- ##### FUNCTION e_data_book_view_get_backend ##### --> <para> </para> @@ -143,7 +165,7 @@ EDataBookView </para> @book_view: -@Param2: +@status: <!-- ##### FUNCTION e_data_book_view_notify_status_message ##### --> diff --git a/docs/reference/addressbook/libedata-book/tmpl/e-data-book.sgml b/docs/reference/addressbook/libedata-book/tmpl/e-data-book.sgml index 5feb661f3..d672dd1e9 100644 --- a/docs/reference/addressbook/libedata-book/tmpl/e-data-book.sgml +++ b/docs/reference/addressbook/libedata-book/tmpl/e-data-book.sgml @@ -23,23 +23,37 @@ EDataBook </para> -<!-- ##### FUNCTION e_data_book_new ##### --> +<!-- ##### SIGNAL EDataBook::auth-required ##### --> <para> </para> -@backend: -@source: -@listener: -@Returns: +@edatabook: the object which received the signal. +<!-- ##### SIGNAL EDataBook::connection ##### --> +<para> + +</para> -<!-- ##### FUNCTION e_data_book_get_listener ##### --> +@edatabook: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EDataBook::writable ##### --> <para> </para> -@book: +@edatabook: the object which received the signal. +@arg1: + +<!-- ##### FUNCTION e_data_book_new ##### --> +<para> + +</para> + +@backend: +@source: +@closed_cb: @Returns: @@ -157,17 +171,6 @@ EDataBook @fields: -<!-- ##### FUNCTION e_data_book_respond_get_book_view ##### --> -<para> - -</para> - -@book: -@opid: -@status: -@book_view: - - <!-- ##### FUNCTION e_data_book_respond_get_contact ##### --> <para> diff --git a/docs/reference/addressbook/libedata-book/tmpl/libedata-book-unused.sgml b/docs/reference/addressbook/libedata-book/tmpl/libedata-book-unused.sgml index 75d96917c..38a8607bb 100644 --- a/docs/reference/addressbook/libedata-book/tmpl/libedata-book-unused.sgml +++ b/docs/reference/addressbook/libedata-book/tmpl/libedata-book-unused.sgml @@ -158,6 +158,60 @@ e-data-book-types </para> +<!-- ##### FUNCTION e_data_book_factory_activate ##### --> +<para> + +</para> + +@factory: +@iid: +@Returns: + +<!-- ##### FUNCTION e_data_book_factory_dump_active_backends ##### --> +<para> + +</para> + +@factory: + +<!-- ##### FUNCTION e_data_book_factory_get_n_backends ##### --> +<para> + +</para> + +@factory: +@Returns: + +<!-- ##### FUNCTION e_data_book_factory_new ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION e_data_book_factory_register_backend ##### --> +<para> + +</para> + +@factory: +@backend_factory: + +<!-- ##### FUNCTION e_data_book_factory_register_backends ##### --> +<para> + +</para> + +@factory: + +<!-- ##### FUNCTION e_data_book_get_listener ##### --> +<para> + +</para> + +@book: +@Returns: + <!-- ##### MACRO e_data_book_marshal_NONE__NONE ##### --> <para> @@ -182,3 +236,29 @@ e-data-book-types </para> +<!-- ##### FUNCTION e_data_book_respond_get_book_view ##### --> +<para> + +</para> + +@book: +@opid: +@status: +@book_view: + +<!-- ##### FUNCTION e_data_book_view_get_listener ##### --> +<para> + +</para> + +@book_view: +@Returns: + +<!-- ##### FUNCTION e_data_book_view_get_mutex ##### --> +<para> + +</para> + +@book_view: +@Returns: + |