diff options
author | Patrick Griffis <pgriffis@igalia.com> | 2022-04-14 12:47:11 -0500 |
---|---|---|
committer | Patrick Griffis <pgriffis@igalia.com> | 2022-04-14 12:47:23 -0500 |
commit | d6ef34797a4804c21be28dd99f84e5b72e32f3ee (patch) | |
tree | 177aed7a334c5040cbcebf0ed0f431378b1e3ed6 | |
parent | a6581262c62ec39409e614f0e8f6763878a7d37d (diff) | |
download | libsoup-d6ef34797a4804c21be28dd99f84e5b72e32f3ee.tar.gz |
docs: Document error quark functions
-rw-r--r-- | libsoup/soup-session.h | 6 | ||||
-rw-r--r-- | libsoup/soup-tld.h | 8 | ||||
-rw-r--r-- | libsoup/websocket/soup-websocket.h | 6 |
3 files changed, 19 insertions, 1 deletions
diff --git a/libsoup/soup-session.h b/libsoup/soup-session.h index 053cc39c..13e5a4f5 100644 --- a/libsoup/soup-session.h +++ b/libsoup/soup-session.h @@ -33,6 +33,12 @@ struct _SoupSessionClass { void (*_soup_reserved8) (void); }; +/** + * soup_session_error_quark: + * Registers error quark for SoupSession if needed. + * + * Returns: Error quark for SoupSession. + */ SOUP_AVAILABLE_IN_ALL GQuark soup_session_error_quark (void); #define SOUP_SESSION_ERROR soup_session_error_quark () diff --git a/libsoup/soup-tld.h b/libsoup/soup-tld.h index 8655a3ac..4825cd34 100644 --- a/libsoup/soup-tld.h +++ b/libsoup/soup-tld.h @@ -16,7 +16,13 @@ const char *soup_tld_get_base_domain (const char *hostname, SOUP_AVAILABLE_IN_ALL gboolean soup_tld_domain_is_public_suffix (const char *domain); -/* Errors */ + +/** + * soup_tld_error_quark: + * Registers error quark for soup_tld_get_base_domain() if needed. + * + * Returns: Error quark for Soup TLD functions. + */ SOUP_AVAILABLE_IN_ALL GQuark soup_tld_error_quark (void); #define SOUP_TLD_ERROR soup_tld_error_quark() diff --git a/libsoup/websocket/soup-websocket.h b/libsoup/websocket/soup-websocket.h index decc4094..528c961d 100644 --- a/libsoup/websocket/soup-websocket.h +++ b/libsoup/websocket/soup-websocket.h @@ -24,6 +24,12 @@ G_BEGIN_DECLS +/** + * soup_websocket_error_quark: + * Registers error quark for SoupWebsocket if needed. + * + * Returns: Error quark for SoupWebsocket. + */ #define SOUP_WEBSOCKET_ERROR (soup_websocket_error_quark ()) SOUP_AVAILABLE_IN_ALL GQuark soup_websocket_error_quark (void) G_GNUC_CONST; |