[gnome-online-accounts] telepathy: Documentation fixes

[Debarshi Ray <debarshir src gnome org>]

commit 5d988643e6a6ecb64bd05af6f27ebb922f5eda53
Author: Emanuele Aina <emanuele aina collabora com>
Date:   Tue Aug 20 21:41:39 2013 +0200

    telepathy: Documentation fixes
    
    • Wire up the new classes to gtk-doc
    • Use consistent naming for the provider_[name|type] parameter in
      goa_provider_factory_get_provider()
    • Expand a bit on the provider_name meaning
    
    https://bugzilla.gnome.org/show_bug.cgi?id=712535

 doc/goa-docs.xml                     |    3 ++
 doc/goa-sections.txt                 |   45 ++++++++++++++++++++++++++++++++++
 src/goabackend/goaproviderfactory.c  |   12 +++++----
 src/goabackend/goatelepathyfactory.c |    3 ++
 4 files changed, 58 insertions(+), 5 deletions(-)
---
diff --git a/doc/goa-docs.xml b/doc/goa-docs.xml
index 1adacef..ecc51c4 100644
--- a/doc/goa-docs.xml
+++ b/doc/goa-docs.xml
@@ -161,6 +161,7 @@
       <xi:include href="xml/goalog.xml"/>
       <xi:include href="xml/goautil.xml"/>
       <xi:include href="xml/goaprovider.xml"/>
+      <xi:include href="xml/goaproviderfactory.xml"/>
       <xi:include href="xml/goaoauthprovider.xml"/>
       <xi:include href="xml/goaoauth2provider.xml"/>
     </chapter>
@@ -173,6 +174,8 @@
       <xi:include href="xml/goayahooprovider.xml"/>
       <xi:include href="xml/goatwitterprovider.xml"/>
       <xi:include href="xml/goaflickrprovider.xml"/>
+      <xi:include href="xml/goatelepathyfactory.xml"/>
+      <xi:include href="xml/goatelepathyprovider.xml"/>
     </chapter>
   </part>
 
diff --git a/doc/goa-sections.txt b/doc/goa-sections.txt
index 1f43217..5e10d7c 100644
--- a/doc/goa-sections.txt
+++ b/doc/goa-sections.txt
@@ -446,6 +446,24 @@ goa_provider_get_type
 </SECTION>
 
 <SECTION>
+<FILE>goaproviderfactory</FILE>
+GoaProviderFactory
+GoaProviderFactoryClass
+GOA_PROVIDER_FACTORY_EXTENSION_POINT_NAME
+goa_provider_factory_get_provider
+goa_provider_factory_get_providers
+goa_provider_factory_get_providers_finish
+<SUBSECTION Standard>
+GOA_PROVIDER_FACTORY
+GOA_PROVIDER_FACTORY_CLASS
+GOA_PROVIDER_FACTORY_GET_CLASS
+GOA_IS_PROVIDER_FACTORY
+GOA_IS_PROVIDER_FACTORY_CLASS
+GOA_TYPE_PROVIDER_FACTORY
+goa_provider_factory_get_type
+</SECTION>
+
+<SECTION>
 <FILE>goaoauth2provider</FILE>
 GoaOAuth2Provider
 GoaOAuth2ProviderClass
@@ -580,6 +598,33 @@ goa_flickr_provider_get_type
 </SECTION>
 
 <SECTION>
+<FILE>goatelepathyfactory</FILE>
+GoaTelepathyFactory
+GoaTelepathyFactoryClass
+<SUBSECTION Standard>
+GOA_TELEPATHY_FACTORY
+GOA_TELEPATHY_FACTORY_CLASS
+GOA_TELEPATHY_FACTORY_GET_CLASS
+GOA_IS_TELEPATHY_FACTORY
+GOA_IS_TELEPATHY_FACTORY_CLASS
+GOA_TYPE_TELEPATHY_FACTORY
+goa_telepathy_factory_get_type
+</SECTION>
+
+<SECTION>
+<FILE>goatelepathyprovider</FILE>
+GoaTelepathyProvider
+GOA_TELEPATHY_PROVIDER_BASE_TYPE
+goa_telepathy_provider_new_from_protocol_name
+goa_telepathy_provider_new_from_protocol
+<SUBSECTION Standard>
+GOA_TELEPATHY_PROVIDER
+GOA_IS_TELEPATHY_PROVIDER
+GOA_TYPE_TELEPATHY_PROVIDER
+goa_telepathy_provider_get_type
+</SECTION>
+
+<SECTION>
 <FILE>GoaMail</FILE>
 GoaMail
 GoaMailIface
diff --git a/src/goabackend/goaproviderfactory.c b/src/goabackend/goaproviderfactory.c
index 883e1ef..df1cb09 100644
--- a/src/goabackend/goaproviderfactory.c
+++ b/src/goabackend/goaproviderfactory.c
@@ -38,25 +38,27 @@ G_DEFINE_ABSTRACT_TYPE (GoaProviderFactory, goa_provider_factory, G_TYPE_OBJECT)
 
 /**
  * goa_provider_factory_get_provider:
+ * @factory: A #GoaProviderFactory.
+ * @provider_name: A provider type identifier (ie. IM protocol names in #GoaTelepathyFactory)
  *
- * Create a dynamic #GoaProvider for @provider_type.
+ * Create a dynamic #GoaProvider for the subclass-specific @provider_name.
  *
  * Returns: (transfer full): A #GoaProvider (that must be freed
  * with g_object_unref()) or %NULL if not found.
  */
 GoaProvider *
 goa_provider_factory_get_provider (GoaProviderFactory  *factory,
-                                   const gchar         *provider_type)
+                                   const gchar         *provider_name)
 {
   GoaProviderFactoryClass *klass;
 
   g_return_val_if_fail (GOA_IS_PROVIDER_FACTORY (factory), NULL);
-  g_return_val_if_fail (provider_type != NULL, NULL);
+  g_return_val_if_fail (provider_name != NULL, NULL);
 
   klass = GOA_PROVIDER_FACTORY_GET_CLASS (factory);
   g_return_val_if_fail (klass->get_provider != NULL, NULL);
 
-  return klass->get_provider (factory, provider_type);
+  return klass->get_provider (factory, provider_name);
 }
 
 /* ---------------------------------------------------------------------------------------------------- */
@@ -96,7 +98,7 @@ goa_provider_factory_get_providers (GoaProviderFactory  *factory,
  * goa_provider_factory_get_providers_finish:
  * @factory: A #GoaProviderFactory.
  * @out_providers: (out): Return location for a list of #GoaProvider instances handled by @factory.
- * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to 
goa_provider_factory_get_providers().
+ * @result: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to 
goa_provider_factory_get_providers().
  * @error: Return location for error or %NULL.
  *
  * Finishes an operation started with goa_provider_factory_get_providers()
diff --git a/src/goabackend/goatelepathyfactory.c b/src/goabackend/goatelepathyfactory.c
index 5f58800..097b984 100644
--- a/src/goabackend/goatelepathyfactory.c
+++ b/src/goabackend/goatelepathyfactory.c
@@ -35,6 +35,9 @@
  *
  * #GoaTelepathyFactory dynamically creates instances of #GoaTelepathyProvider
  * based on the protocols available through Telepathy.
+ *
+ * It accepts the protocol names from the Telepathy specification as
+ * @provider_name in goa_provider_factory_get_provider().
  */
 
 G_DEFINE_TYPE_WITH_CODE (GoaTelepathyFactory, goa_telepathy_factory, GOA_TYPE_PROVIDER_FACTORY,