GNOME.org
 

[gnome-online-accounts] Clean up docs

commit 0daf2c000f126284e24cd40d8fe2d794cf779571
Author: Debarshi Ray <debarshir gnome org>
Date:   Wed May 31 13:18:13 2017 +0200

    Clean up docs
    
    Removed all the leaf-level GoaProvider sub-classes (for example,
    GoaExchangeProvider, GoaGoogleProvider, GoaMediaServerProvider, etc.)
    from the public API documentation. These extension types are not
    exposed via the goa-backend-1.0 API. They are only available as
    GoaProviders.

 doc/goa-docs.xml                        |   12 ----
 doc/goa-sections.txt                    |   91 -------------------------------
 doc/goa.types                           |    7 ---
 src/goabackend/goaexchangeprovider.c    |   15 -----
 src/goabackend/goafacebookprovider.c    |   15 -----
 src/goabackend/goaflickrprovider.c      |   15 -----
 src/goabackend/goafoursquareprovider.c  |   15 -----
 src/goabackend/goagoogleprovider.c      |   15 -----
 src/goabackend/goalastfmprovider.c      |    1 -
 src/goabackend/goamediaserverprovider.c |   14 -----
 src/goabackend/goatelepathyprovider.c   |   15 -----
 src/goabackend/goawindowsliveprovider.c |   15 -----
 12 files changed, 0 insertions(+), 230 deletions(-)
---
diff --git a/doc/goa-docs.xml b/doc/goa-docs.xml
index cdce050..e53f781 100644
--- a/doc/goa-docs.xml
+++ b/doc/goa-docs.xml
@@ -171,18 +171,6 @@
       <xi:include href="xml/goaoauthprovider.xml"/>
       <xi:include href="xml/goaoauth2provider.xml"/>
     </chapter>
-    <chapter>
-      <title>Providers</title>
-      <xi:include href="xml/goaexchangeprovider.xml"/>
-      <xi:include href="xml/goagoogleprovider.xml"/>
-      <xi:include href="xml/goamediaserverprovider.xml"/>
-      <xi:include href="xml/goawindowsliveprovider.xml"/>
-      <xi:include href="xml/goafacebookprovider.xml"/>
-      <xi:include href="xml/goaflickrprovider.xml"/>
-      <xi:include href="xml/goafoursquareprovider.xml"/>
-      <xi:include href="xml/goatelepathyprovider.xml"/>
-      <xi:include href="xml/goalastfmprovider.xml"/>
-    </chapter>
   </part>
 
   <part id="tools-fileformats">
diff --git a/doc/goa-sections.txt b/doc/goa-sections.txt
index fd0d881..057e68c 100644
--- a/doc/goa-sections.txt
+++ b/doc/goa-sections.txt
@@ -522,97 +522,6 @@ goa_oauth_provider_get_type
 </SECTION>
 
 <SECTION>
-<FILE>goaexchangeprovider</FILE>
-GoaExchangeProvider
-<SUBSECTION Standard>
-GOA_EXCHANGE_PROVIDER
-GOA_IS_EXCHANGE_PROVIDER
-GOA_TYPE_EXCHANGE_PROVIDER
-goa_exchange_provider_get_type
-</SECTION>
-
-<SECTION>
-<FILE>goamediaserverprovider</FILE>
-GoaMediaServerProvider
-<SUBSECTION Standard>
-GOA_MEDIA_SERVER_PROVIDER
-GOA_IS_MEDIA_SERVER_PROVIDER
-GOA_TYPE_MEDIA_SERVER_PROVIDER
-goa_media_server_provider_get_type
-</SECTION>
-
-<SECTION>
-<FILE>goagoogleprovider</FILE>
-GoaGoogleProvider
-<SUBSECTION Standard>
-GOA_GOOGLE_PROVIDER
-GOA_IS_GOOGLE_PROVIDER
-GOA_TYPE_GOOGLE_PROVIDER
-goa_google_provider_get_type
-</SECTION>
-
-<SECTION>
-<FILE>goawindowsliveprovider</FILE>
-GoaWindowsLiveProvider
-<SUBSECTION Standard>
-GOA_WINDOWS_LIVE_PROVIDER
-GOA_IS_WINDOWS_LIVE_PROVIDER
-GOA_TYPE_WINDOWS_LIVE_PROVIDER
-goa_windows_live_provider_get_type
-</SECTION>
-
-<SECTION>
-<FILE>goafacebookprovider</FILE>
-GoaFacebookProvider
-<SUBSECTION Standard>
-GOA_FACEBOOK_PROVIDER
-GOA_IS_FACEBOOK_PROVIDER
-GOA_TYPE_FACEBOOK_PROVIDER
-goa_facebook_provider_get_type
-</SECTION>
-
-<SECTION>
-<FILE>goaflickrprovider</FILE>
-GoaFlickrProvider
-<SUBSECTION Standard>
-GOA_FLICKR_PROVIDER
-GOA_IS_FLICKR_PROVIDER
-GOA_TYPE_FLICKR_PROVIDER
-goa_flickr_provider_get_type
-</SECTION>
-
-<SECTION>
-<FILE>goafoursquareprovider</FILE>
-GoaFoursquareProvider
-<SUBSECTION Standard>
-GOA_FOURSQUARE_PROVIDER
-GOA_IS_FOURSQUARE_PROVIDER
-GOA_TYPE_FOURSQUARE_PROVIDER
-goa_foursquare_provider_get_type
-</SECTION>
-
-<SECTION>
-<FILE>goatelepathyprovider</FILE>
-GoaTelepathyProvider
-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>
-
-<FILE>goalastfmprovider</FILE>
-GoaLastfmProvider
-<SUBSECTION Standard>
-GOA_LASTFM_PROVIDER
-GOA_IS_LASTFM_PROVIDER
-GOA_TYPE_LASTFM_PROVIDER
-goa_lastfm_provider_get_type
-</SECTION>
-
-<SECTION>
 <FILE>GoaMail</FILE>
 GoaMail
 GoaMailIface
diff --git a/doc/goa.types b/doc/goa.types
index 98354b7..56ba3c4 100644
--- a/doc/goa.types
+++ b/doc/goa.types
@@ -64,10 +64,3 @@ goa_printers_skeleton_get_type
 goa_provider_get_type
 goa_oauth_provider_get_type
 goa_oauth2_provider_get_type
-goa_google_provider_get_type
-goa_facebook_provider_get_type
-goa_media_server_provider_get_type
-goa_flickr_provider_get_type
-goa_foursquare_provider_get_type
-goa_windows_live_provider_get_type
-goa_lastfm_provider_get_type
diff --git a/src/goabackend/goaexchangeprovider.c b/src/goabackend/goaexchangeprovider.c
index 63ebe21..a5dddae 100644
--- a/src/goabackend/goaexchangeprovider.c
+++ b/src/goabackend/goaexchangeprovider.c
@@ -26,15 +26,8 @@
 #include "goaobjectskeletonutils.h"
 #include "goautils.h"
 
-/**
- * GoaExchangeProvider:
- *
- * The #GoaExchangeProvider structure contains only private data and should
- * only be accessed using the provided API.
- */
 struct _GoaExchangeProvider
 {
-  /*< private >*/
   GoaProvider parent_instance;
 };
 
@@ -45,14 +38,6 @@ struct _GoaExchangeProviderClass
   GoaProviderClass parent_class;
 };
 
-/**
- * SECTION:goaexchangeprovider
- * @title: GoaExchangeProvider
- * @short_description: A provider for Microsoft Exchange servers
- *
- * #GoaExchangeProvider is used to access Microsoft Exchange servers.
- */
-
 G_DEFINE_TYPE_WITH_CODE (GoaExchangeProvider, goa_exchange_provider, GOA_TYPE_PROVIDER,
                          goa_provider_ensure_extension_points_registered ();
                          g_io_extension_point_implement (GOA_PROVIDER_EXTENSION_POINT_NAME,
diff --git a/src/goabackend/goafacebookprovider.c b/src/goabackend/goafacebookprovider.c
index d463070..8324d7f 100644
--- a/src/goabackend/goafacebookprovider.c
+++ b/src/goabackend/goafacebookprovider.c
@@ -29,15 +29,8 @@
 #include "goafacebookprovider.h"
 #include "goaobjectskeletonutils.h"
 
-/**
- * GoaFacebookProvider:
- *
- * The #GoaFacebookProvider structure contains only private data and should
- * only be accessed using the provided API.
- */
 struct _GoaFacebookProvider
 {
-  /*< private >*/
   GoaOAuth2Provider parent_instance;
 };
 
@@ -48,14 +41,6 @@ struct _GoaFacebookProviderClass
   GoaOAuth2ProviderClass parent_class;
 };
 
-/**
- * SECTION:goafacebookprovider
- * @title: GoaFacebookProvider
- * @short_description: A provider for Facebook
- *
- * #GoaFacebookProvider is used for handling Facebook accounts.
- */
-
 G_DEFINE_TYPE_WITH_CODE (GoaFacebookProvider, goa_facebook_provider, GOA_TYPE_OAUTH2_PROVIDER,
                          goa_provider_ensure_extension_points_registered ();
                          g_io_extension_point_implement (GOA_PROVIDER_EXTENSION_POINT_NAME,
diff --git a/src/goabackend/goaflickrprovider.c b/src/goabackend/goaflickrprovider.c
index 410a9f1..ae6bcde 100644
--- a/src/goabackend/goaflickrprovider.c
+++ b/src/goabackend/goaflickrprovider.c
@@ -29,15 +29,8 @@
 #include "goaflickrprovider.h"
 #include "goaobjectskeletonutils.h"
 
-/**
- * GoaFlickrProvider:
- *
- * The #GoaFlickrProvider structure contains only private data and should
- * only be accessed using the provided API.
- */
 struct _GoaFlickrProvider
 {
-  /*< private >*/
   GoaOAuthProvider parent_instance;
 };
 
@@ -48,14 +41,6 @@ struct _GoaFlickrProviderClass
   GoaOAuthProviderClass parent_class;
 };
 
-/**
- * SECTION:goaflickrprovider
- * @title: GoaFlickrProvider
- * @short_description: A provider for Flickr
- *
- * #GoaFlickrProvider is used for handling Flickr accounts.
- */
-
 G_DEFINE_TYPE_WITH_CODE (GoaFlickrProvider, goa_flickr_provider, GOA_TYPE_OAUTH_PROVIDER,
                          goa_provider_ensure_extension_points_registered ();
                          g_io_extension_point_implement (GOA_PROVIDER_EXTENSION_POINT_NAME,
diff --git a/src/goabackend/goafoursquareprovider.c b/src/goabackend/goafoursquareprovider.c
index 40a9c83..a4191ce 100644
--- a/src/goabackend/goafoursquareprovider.c
+++ b/src/goabackend/goafoursquareprovider.c
@@ -30,15 +30,8 @@
 #include "goafoursquareprovider.h"
 #include "goaobjectskeletonutils.h"
 
-/**
- * GoaFoursquareProvider:
- *
- * The #GoaFoursquareProvider structure contains only private data and should
- * only be accessed using the provided API.
- */
 struct _GoaFoursquareProvider
 {
-  /*< private >*/
   GoaOAuth2Provider parent_instance;
 };
 
@@ -49,14 +42,6 @@ struct _GoaFoursquareProviderClass
   GoaOAuth2ProviderClass parent_class;
 };
 
-/**
- * SECTION:goafoursquareprovider
- * @title: GoaFoursquareProvider
- * @short_description: A provider for Foursquare
- *
- * #GoaFoursquareProvider is used for handling Foursquare accounts.
- */
-
 G_DEFINE_TYPE_WITH_CODE (GoaFoursquareProvider, goa_foursquare_provider, GOA_TYPE_OAUTH2_PROVIDER,
                          goa_provider_ensure_extension_points_registered ();
                          g_io_extension_point_implement (GOA_PROVIDER_EXTENSION_POINT_NAME,
diff --git a/src/goabackend/goagoogleprovider.c b/src/goabackend/goagoogleprovider.c
index d08768c..1335618 100644
--- a/src/goabackend/goagoogleprovider.c
+++ b/src/goabackend/goagoogleprovider.c
@@ -29,15 +29,8 @@
 #include "goagoogleprovider.h"
 #include "goaobjectskeletonutils.h"
 
-/**
- * GoaGoogleProvider:
- *
- * The #GoaGoogleProvider structure contains only private data and should
- * only be accessed using the provided API.
- */
 struct _GoaGoogleProvider
 {
-  /*< private >*/
   GoaOAuth2Provider parent_instance;
 };
 
@@ -48,14 +41,6 @@ struct _GoaGoogleProviderClass
   GoaOAuth2ProviderClass parent_class;
 };
 
-/**
- * SECTION:goagoogleprovider
- * @title: GoaGoogleProvider
- * @short_description: A provider for Google
- *
- * #GoaGoogleProvider is used for handling Google accounts.
- */
-
 G_DEFINE_TYPE_WITH_CODE (GoaGoogleProvider, goa_google_provider, GOA_TYPE_OAUTH2_PROVIDER,
                          goa_provider_ensure_extension_points_registered ();
                          g_io_extension_point_implement (GOA_PROVIDER_EXTENSION_POINT_NAME,
diff --git a/src/goabackend/goalastfmprovider.c b/src/goabackend/goalastfmprovider.c
index 63c5058..ac07e66 100644
--- a/src/goabackend/goalastfmprovider.c
+++ b/src/goabackend/goalastfmprovider.c
@@ -32,7 +32,6 @@
 
 struct _GoaLastfmProvider
 {
-  /*< private >*/
   GoaOAuth2Provider parent_instance;
 };
 
diff --git a/src/goabackend/goamediaserverprovider.c b/src/goabackend/goamediaserverprovider.c
index 9a33d32..030ad46 100644
--- a/src/goabackend/goamediaserverprovider.c
+++ b/src/goabackend/goamediaserverprovider.c
@@ -28,12 +28,6 @@
 #include "goadleynaservermediadevice.h"
 #include "goadlnaservermanager.h"
 
-/**
- * GoaMediaServerProvider:
- *
- * The #GoaMediaServerProvider structure contains only private data and should
- * only be accessed using the provided API.
- */
 struct _GoaMediaServerProvider
 {
   GoaProvider parent_instance;
@@ -47,14 +41,6 @@ struct _GoaMediaServerProviderClass
   GoaProviderClass parent_class;
 };
 
-/**
- * SECTION:goamediaserverprovider
- * @title: GoaMediaServerProvider
- * @short_description: A provider for Media Server
- *
- * #GoaMediaServerProvider is used for handling Media Servers.
- */
-
 G_DEFINE_TYPE_WITH_CODE (GoaMediaServerProvider, goa_media_server_provider, GOA_TYPE_PROVIDER,
                          goa_provider_ensure_extension_points_registered ();
                          g_io_extension_point_implement (GOA_PROVIDER_EXTENSION_POINT_NAME,
diff --git a/src/goabackend/goatelepathyprovider.c b/src/goabackend/goatelepathyprovider.c
index ab4f4cb..97234dc 100644
--- a/src/goabackend/goatelepathyprovider.c
+++ b/src/goabackend/goatelepathyprovider.c
@@ -48,15 +48,8 @@ enum {
 
 static GParamSpec *properties[NUM_PROPERTIES] = { NULL, };
 
-/**
- * GoaTelepathyProvider:
- *
- * The #GoaTelepathyProvider structure contains only private data and should
- * only be accessed using the provided API.
- */
 struct _GoaTelepathyProvider
 {
-  /*< private >*/
   GoaProvider parent_instance;
   GoaTelepathyProviderPrivate *priv;
 };
@@ -68,14 +61,6 @@ struct _GoaTelepathyProviderClass
   GoaProviderClass parent_class;
 };
 
-/**
- * SECTION:goatelepathyprovider
- * @title: GoaTelepathyProvider
- * @short_description: A provider for Telepathy
- *
- * #GoaTelepathyProvider is used for handling Telepathy IM accounts.
- */
-
 G_DEFINE_TYPE (GoaTelepathyProvider, goa_telepathy_provider, GOA_TYPE_PROVIDER);
 
 /* ---------------------------------------------------------------------------------------------------- */
diff --git a/src/goabackend/goawindowsliveprovider.c b/src/goabackend/goawindowsliveprovider.c
index 1436e6f..981e825 100644
--- a/src/goabackend/goawindowsliveprovider.c
+++ b/src/goabackend/goawindowsliveprovider.c
@@ -28,26 +28,11 @@
 #include "goawindowsliveprovider.h"
 #include "goaobjectskeletonutils.h"
 
-/**
- * GoaWindowsLiveProvider:
- *
- * The #GoaWindowsLiveProvider structure contains only private data and should
- * only be accessed using the provided API.
- */
 struct _GoaWindowsLiveProvider
 {
-  /*< private >*/
   GoaOAuth2Provider parent_instance;
 };
 
-/**
- * SECTION:goawindowsliveprovider
- * @title: GoaWindowsLiveProvider
- * @short_description: A provider for Windows Live accounts
- *
- * #GoaWindowsLiveProvider is used for handling Windows Live accounts.
- */
-
 G_DEFINE_TYPE_WITH_CODE (GoaWindowsLiveProvider, goa_windows_live_provider, GOA_TYPE_OAUTH2_PROVIDER,
                          goa_provider_ensure_extension_points_registered ();
                          g_io_extension_point_implement (GOA_PROVIDER_EXTENSION_POINT_NAME,
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]