GNOME.org
 

[gnome-online-accounts] Fix and update docs

commit 0572f42a46f857d0763097625c3fb5f2b31834bf
Author: Debarshi Ray <debarshir gnome org>
Date:   Sun Oct 21 20:02:55 2012 +0200

    Fix and update docs

 doc/Makefile.am                    |    6 +++-
 doc/goa-docs.xml                   |   11 ++++++
 doc/goa-sections.txt               |   64 ++++++++++++++++++++++++++++++++++++
 doc/goa.types                      |    6 +++
 src/goabackend/goalogging.h        |   20 ++++++------
 src/goabackend/goaoauth2provider.c |   10 +++---
 src/goabackend/goaoauthprovider.c  |   10 +++---
 src/goabackend/goaprovider.c       |   10 +++--
 src/goabackend/goaprovider.h       |    1 +
 9 files changed, 113 insertions(+), 25 deletions(-)
---
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 1091cab..bdeb48f 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -67,7 +67,11 @@ man_MANS +=			\
 endif
 
 .xml.8:
-	$(XSLTPROC) --nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+	$(AM_V_GEN) $(XSLTPROC) \
+	  --nonet \
+	  --stringparam man.output.quietly 1 \
+	  --stringparam funcsynopsis.style ansi \
+	  http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
 
 if ENABLE_GTK_DOC
 include $(top_srcdir)/gtk-doc.make
diff --git a/doc/goa-docs.xml b/doc/goa-docs.xml
index 0fa1ddd..a49b7d3 100644
--- a/doc/goa-docs.xml
+++ b/doc/goa-docs.xml
@@ -17,6 +17,15 @@
 	  </address>
 	</affiliation>
       </author>
+      <author>
+	<firstname>Debarshi</firstname>
+	<surname>Ray</surname>
+	<affiliation>
+	  <address>
+	    <email>debarshir gnome org</email>
+	  </address>
+	</affiliation>
+      </author>
     </authorgroup>
 
     <copyright>
@@ -112,6 +121,7 @@
       <xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Contacts.xml"/>
       <xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Chat.xml"/>
       <xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Documents.xml"/>
+      <xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Files.xml"/>
       <xi:include href="../src/goa/goa-generated-doc-org.gnome.OnlineAccounts.Exchange.xml"/>
     </chapter>
   </part>
@@ -135,6 +145,7 @@
       <xi:include href="xml/GoaContacts.xml"/>
       <xi:include href="xml/GoaChat.xml"/>
       <xi:include href="xml/GoaDocuments.xml"/>
+      <xi:include href="xml/GoaFiles.xml"/>
       <xi:include href="xml/GoaExchange.xml"/>
     </chapter>
   </part>
diff --git a/doc/goa-sections.txt b/doc/goa-sections.txt
index 406a4c7..286788f 100644
--- a/doc/goa-sections.txt
+++ b/doc/goa-sections.txt
@@ -57,6 +57,7 @@ goa_object_get_calendar
 goa_object_get_contacts
 goa_object_get_chat
 goa_object_get_documents
+goa_object_get_files
 goa_object_get_exchange
 goa_object_peek_manager
 goa_object_peek_account
@@ -67,6 +68,7 @@ goa_object_peek_calendar
 goa_object_peek_contacts
 goa_object_peek_chat
 goa_object_peek_documents
+goa_object_peek_files
 goa_object_peek_exchange
 GoaObjectProxy
 GoaObjectProxyClass
@@ -83,6 +85,7 @@ goa_object_skeleton_set_calendar
 goa_object_skeleton_set_contacts
 goa_object_skeleton_set_chat
 goa_object_skeleton_set_documents
+goa_object_skeleton_set_files
 goa_object_skeleton_set_exchange
 <SUBSECTION Standard>
 goa_object_get_type
@@ -144,6 +147,8 @@ goa_account_get_chat_disabled
 goa_account_set_chat_disabled
 goa_account_get_documents_disabled
 goa_account_set_documents_disabled
+goa_account_get_files_disabled
+goa_account_set_files_disabled
 goa_account_call_ensure_credentials
 goa_account_call_ensure_credentials_finish
 goa_account_call_ensure_credentials_sync
@@ -431,12 +436,16 @@ goa_provider_get_type
 <FILE>goaoauth2provider</FILE>
 GoaOAuth2Provider
 GoaOAuth2ProviderClass
+goa_oauth2_provider_get_authentication_cookie
 goa_oauth2_provider_get_authorization_uri
 goa_oauth2_provider_get_token_uri
 goa_oauth2_provider_get_redirect_uri
 goa_oauth2_provider_get_scope
 goa_oauth2_provider_get_client_id
 goa_oauth2_provider_get_client_secret
+goa_oauth2_provider_get_use_mobile_browser
+goa_oauth2_provider_is_deny_node
+goa_oauth2_provider_is_identity_node
 goa_oauth2_provider_build_authorization_uri
 goa_oauth2_provider_get_use_external_browser
 goa_oauth2_provider_add_account_key_values
@@ -457,6 +466,7 @@ goa_oauth2_provider_get_type
 <FILE>goaoauthprovider</FILE>
 GoaOAuthProvider
 GoaOAuthProviderClass
+goa_oauth_provider_get_authentication_cookie
 goa_oauth_provider_get_request_uri
 goa_oauth_provider_get_request_uri_params
 goa_oauth_provider_get_authorization_uri
@@ -466,9 +476,13 @@ goa_oauth_provider_get_consumer_key
 goa_oauth_provider_get_consumer_secret
 goa_oauth_provider_build_authorization_uri
 goa_oauth_provider_get_use_external_browser
+goa_oauth_provider_get_use_mobile_browser
+goa_oauth_provider_is_deny_node
+goa_oauth_provider_is_identity_node
 goa_oauth_provider_add_account_key_values
 goa_oauth_provider_get_identity_sync
 goa_oauth_provider_get_access_token_sync
+goa_oauth_provider_parse_request_token_error
 <SUBSECTION Standard>
 GOA_OAUTH_PROVIDER
 GOA_OAUTH_PROVIDER_CLASS
@@ -620,6 +634,9 @@ GoaCalendar
 GoaCalendarIface
 goa_calendar_interface_info
 goa_calendar_override_properties
+goa_calendar_get_uri
+goa_calendar_dup_uri
+goa_calendar_set_uri
 GoaCalendarProxy
 GoaCalendarProxyClass
 goa_calendar_proxy_new
@@ -661,6 +678,9 @@ GoaContacts
 GoaContactsIface
 goa_contacts_interface_info
 goa_contacts_override_properties
+goa_contacts_get_uri
+goa_contacts_dup_uri
+goa_contacts_set_uri
 GoaContactsProxy
 GoaContactsProxyClass
 goa_contacts_proxy_new
@@ -779,6 +799,50 @@ goa_documents_skeleton_get_type
 </SECTION>
 
 <SECTION>
+<FILE>GoaFiles</FILE>
+GoaFiles
+GoaFilesIface
+goa_files_override_properties
+goa_files_interface_info
+goa_files_get_uri
+goa_files_dup_uri
+goa_files_set_uri
+GoaFilesProxy
+GoaFilesProxyClass
+goa_files_proxy_new
+goa_files_proxy_new_finish
+goa_files_proxy_new_sync
+goa_files_proxy_new_for_bus
+goa_files_proxy_new_for_bus_finish
+goa_files_proxy_new_for_bus_sync
+GoaFilesSkeleton
+GoaFilesSkeletonClass
+goa_files_skeleton_new
+<SUBSECTION Standard>
+GOA_TYPE_FILES
+GOA_IS_FILES
+GOA_FILES
+GOA_FILES_GET_IFACE
+GOA_TYPE_FILES_PROXY
+GOA_IS_FILES_PROXY
+GOA_IS_FILES_PROXY_CLASS
+GOA_FILES_PROXY
+GOA_FILES_PROXY_CLASS
+GOA_FILES_PROXY_GET_CLASS
+GOA_TYPE_FILES_SKELETON
+GOA_IS_FILES_SKELETON
+GOA_IS_FILES_SKELETON_CLASS
+GOA_FILES_SKELETON
+GOA_FILES_SKELETON_CLASS
+GOA_FILES_SKELETON_GET_CLASS
+GoaFilesProxyPrivate
+GoaFilesSkeletonPrivate
+goa_files_get_type
+goa_files_proxy_get_type
+goa_files_skeleton_get_type
+</SECTION>
+
+<SECTION>
 <FILE>GoaExchange</FILE>
 GoaExchange
 GoaExchangeIface
diff --git a/doc/goa.types b/doc/goa.types
index 0726a03..4831f43 100644
--- a/doc/goa.types
+++ b/doc/goa.types
@@ -20,6 +20,12 @@ goa_calendar_skeleton_get_type
 goa_contacts_get_type
 goa_contacts_proxy_get_type
 goa_contacts_skeleton_get_type
+goa_chat_get_type
+goa_chat_proxy_get_type
+goa_chat_skeleton_get_type
+goa_files_get_type
+goa_files_proxy_get_type
+goa_files_skeleton_get_type
 
 goa_provider_get_type
 goa_oauth_provider_get_type
diff --git a/src/goabackend/goalogging.h b/src/goabackend/goalogging.h
index 6809313..b07c7b1 100644
--- a/src/goabackend/goalogging.h
+++ b/src/goabackend/goalogging.h
@@ -39,43 +39,43 @@ void goa_log (GoaLogLevel     level,
 
 /**
  * goa_debug:
- * @args: printf()-style format string and arguments
+ * @...: printf()-style format string and arguments
  *
  * Logging macro for %GOA_LOG_LEVEL_DEBUG.
  */
-#define goa_debug(args...)   goa_log(GOA_LOG_LEVEL_DEBUG, G_STRFUNC, G_STRLOC, args);
+#define goa_debug(...)   goa_log(GOA_LOG_LEVEL_DEBUG, G_STRFUNC, G_STRLOC, __VA_ARGS__);
 
 /**
  * goa_info:
- * @args: printf()-style format string and arguments
+ * @...: printf()-style format string and arguments
  *
  * Logging macro for %GOA_LOG_LEVEL_INFO.
  */
-#define goa_info(args...)    goa_log(GOA_LOG_LEVEL_INFO, G_STRFUNC, G_STRLOC, args);
+#define goa_info(...)    goa_log(GOA_LOG_LEVEL_INFO, G_STRFUNC, G_STRLOC, __VA_ARGS__);
 
 /**
  * goa_notice:
- * @args: printf()-style format string and arguments
+ * @...: printf()-style format string and arguments
  *
  * Logging macro for %GOA_LOG_LEVEL_NOTICE.
  */
-#define goa_notice(args...)    goa_log(GOA_LOG_LEVEL_NOTICE, G_STRFUNC, G_STRLOC, args);
+#define goa_notice(...)    goa_log(GOA_LOG_LEVEL_NOTICE, G_STRFUNC, G_STRLOC, __VA_ARGS__);
 
 /**
  * goa_warning:
- * @args: printf()-style format string and arguments
+ * @...: printf()-style format string and arguments
  *
  * Logging macro for %GOA_LOG_LEVEL_WARNING.
  */
-#define goa_warning(args...) goa_log(GOA_LOG_LEVEL_WARNING, G_STRFUNC, G_STRLOC, args);
+#define goa_warning(...) goa_log(GOA_LOG_LEVEL_WARNING, G_STRFUNC, G_STRLOC, __VA_ARGS__);
 
 /**
  * goa_error:
- * @args: printf()-style format string and arguments
+ * @...: printf()-style format string and arguments
  *
  * Logging macro for %GOA_LOG_LEVEL_ERROR.
  */
-#define goa_error(args...)   goa_log(GOA_LOG_LEVEL_ERROR, G_STRFUNC, G_STRLOC, args);
+#define goa_error(...)   goa_log(GOA_LOG_LEVEL_ERROR, G_STRFUNC, G_STRLOC, __VA_ARGS__);
 
 
 G_END_DECLS
diff --git a/src/goabackend/goaoauth2provider.c b/src/goabackend/goaoauth2provider.c
index 8778cd5..2e1a23f 100644
--- a/src/goabackend/goaoauth2provider.c
+++ b/src/goabackend/goaoauth2provider.c
@@ -438,11 +438,11 @@ goa_oauth2_provider_get_identity_sync (GoaOAuth2Provider    *provider,
 /**
  * goa_oauth2_provider_is_deny_node:
  * @provider: A #GoaOAuth2Provider.
- * @node: A #WebKitDOMNode.
+ * @node: A WebKitDOMNode.
  *
  * Checks whether @node is the HTML UI element that the user can use
  * to deny permission to access his account. Usually they are either a
- * #WebKitDOMHTMLButtonElement or a #WebKitDOMHTMLInputElement.
+ * WebKitDOMHTMLButtonElement or a WebKitDOMHTMLInputElement.
  *
  * Please note that providers may have multiple such elements in their
  * UI and this method should catch all of them.
@@ -462,10 +462,10 @@ goa_oauth2_provider_is_deny_node (GoaOAuth2Provider *provider, WebKitDOMNode *no
 /**
  * goa_oauth2_provider_is_identity_node:
  * @provider: A #GoaOAuth2Provider.
- * @node: A #WebKitDOMHTMLInputElement.
+ * @element: A WebKitDOMHTMLInputElement.
  *
- * Checks whether @node is the HTML UI element that the user can use
- * to identify herself at the provider.
+ * Checks whether @element is the HTML UI element that the user can
+ * use to identify herself at the provider.
  *
  * This is a pure virtual method - a subclass must provide an
  * implementation.
diff --git a/src/goabackend/goaoauthprovider.c b/src/goabackend/goaoauthprovider.c
index 72b12ec..eda9e24 100644
--- a/src/goabackend/goaoauthprovider.c
+++ b/src/goabackend/goaoauthprovider.c
@@ -433,11 +433,11 @@ goa_oauth_provider_get_identity_sync (GoaOAuthProvider *provider,
 /**
  * goa_oauth_provider_is_deny_node:
  * @provider: A #GoaOAuthProvider.
- * @node: A #WebKitDOMNode.
+ * @node: A WebKitDOMNode.
  *
  * Checks whether @node is the HTML UI element that the user can use
  * to deny permission to access his account. Usually they are either a
- * #WebKitDOMHTMLButtonElement or a #WebKitDOMHTMLInputElement.
+ * WebKitDOMHTMLButtonElement or a WebKitDOMHTMLInputElement.
  *
  * Please note that providers may have multiple such elements in their
  * UI and this method should catch all of them.
@@ -457,10 +457,10 @@ goa_oauth_provider_is_deny_node (GoaOAuthProvider *provider, WebKitDOMNode *node
 /**
  * goa_oauth_provider_is_identity_node:
  * @provider: A #GoaOAuthProvider.
- * @node: A #WebKitDOMHTMLInputElement.
+ * @element: A WebKitDOMHTMLInputElement.
  *
- * Checks whether @node is the HTML UI element that the user can use
- * to identify herself at the provider.
+ * Checks whether @element is the HTML UI element that the user can
+ * use to identify herself at the provider.
  *
  * This is a pure virtual method - a subclass must provide an
  * implementation.
diff --git a/src/goabackend/goaprovider.c b/src/goabackend/goaprovider.c
index 0e4983e..a2dd02e 100644
--- a/src/goabackend/goaprovider.c
+++ b/src/goabackend/goaprovider.c
@@ -282,16 +282,18 @@ goa_provider_refresh_account (GoaProvider  *provider,
  * @provider: A #GoaProvider.
  * @client: A #GoaClient.
  * @object: A #GoaObject with a #GoaAccount interface.
- * @dialog: A #GtkDialog.
  * @vbox: A vertically oriented #GtkBox to put content in.
- * @table: A table which is the first element of vbox.
+ * @left: A vertically oriented #GtkGrid to put left-aligned content
+ * in.
+ * @right: A vertically oriented #GtkGrid to put right-aligned content
+ * in.
  *
  * Method used to add widgets in the control panel for the account
  * represented by @object.
  *
  * This is a virtual method with an implementation that (currently)
  * does nothing. A subclass should chain up (before adding their own
- * widgets to @vbox and @table) if they want to expose such
+ * widgets to @vbox, @left and @right) if they want to expose such
  * functionality.
  */
 void
@@ -438,7 +440,7 @@ ensure_credentials_in_thread_func (GSimpleAsyncResult *simple,
  * of the operation.
  *
  * This is a virtual method where the default implementation simply
- * returns the %GOA_ERROR_NOT_SUPPORTED error. A subclass may provide
+ * throws the %GOA_ERROR_NOT_SUPPORTED error. A subclass may provide
  * another implementation.
  */
 void
diff --git a/src/goabackend/goaprovider.h b/src/goabackend/goaprovider.h
index cc58d7e..52821dd 100644
--- a/src/goabackend/goaprovider.h
+++ b/src/goabackend/goaprovider.h
@@ -65,6 +65,7 @@ struct _GoaProvider
  * @refresh_account: Virtual function for goa_provider_refresh_account().
  * @build_object: Virtual function for goa_provider_build_object().
  * @ensure_credentials_sync: Virtual function for goa_provider_ensure_credentials_sync().
+ * @show_account: Virtual function for goa_provider_show_account().
  * @get_credentials_generation: Virtual function for goa_provider_get_credentials_generation().
  *
  * Class structure for #GoaProvider.
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]