libsoup r1231 - in trunk: . docs/reference libsoup

[danw svn gnome org]

Author: danw
Date: Wed Jan 21 17:15:35 2009
New Revision: 1231
URL: http://svn.gnome.org/viewvc/libsoup?rev=1231&view=rev

Log:
	* libsoup/soup-session-feature.h: remove the dummy typedef for
	struct SoupSessionFeature that was needed because we weren't
	scanning soup-types.h. Fixes the build with non-GNU compilers.

	* libsoup/soup-session-feature.c: document
	SoupSessionFeatureInterface

	* docs/reference/Makefile.am (IGNORE_HFILES): oops, don't ignore
	soup-types.h

	* docs/reference/libsoup-2.4-docs.sgml:
	* docs/reference/libsoup-2.4-sections.txt: Split
	SoupSessionFeature into its own file.


Modified:
   trunk/ChangeLog
   trunk/docs/reference/Makefile.am
   trunk/docs/reference/libsoup-2.4-docs.sgml
   trunk/docs/reference/libsoup-2.4-sections.txt
   trunk/libsoup/soup-session-feature.c
   trunk/libsoup/soup-session-feature.h

Modified: trunk/docs/reference/Makefile.am
==============================================================================
--- trunk/docs/reference/Makefile.am	(original)
+++ trunk/docs/reference/Makefile.am	Wed Jan 21 17:15:35 2009
@@ -29,9 +29,8 @@
 CFILE_GLOB=
 
 # Header files to ignore when scanning.
-IGNORE_HFILES= soup.h soup-marshal.h \
+IGNORE_HFILES= soup.h soup-marshal.h soup-enum-types.h \
 	soup-message-private.h soup-session-private.h \
-	soup-types.h soup-enum-types.h \
 	soup-auth-basic.h soup-auth-digest.h soup-auth-ntlm.h \
 	soup-connection.h soup-connection-ntlm.h \
 	soup-dns.h soup-auth-manager.h soup-auth-manager-ntlm.h \

Modified: trunk/docs/reference/libsoup-2.4-docs.sgml
==============================================================================
--- trunk/docs/reference/libsoup-2.4-docs.sgml	(original)
+++ trunk/docs/reference/libsoup-2.4-docs.sgml	Wed Jan 21 17:15:35 2009
@@ -33,6 +33,7 @@
     <xi:include href="xml/soup-session.xml"/>
     <xi:include href="xml/soup-session-async.xml"/>
     <xi:include href="xml/soup-session-sync.xml"/>
+    <xi:include href="xml/soup-session-feature.xml"/>
     <xi:include href="xml/soup-status.xml"/>
     <xi:include href="xml/soup-uri.xml"/>
     <xi:include href="xml/soup-misc.xml"/>

Modified: trunk/docs/reference/libsoup-2.4-sections.txt
==============================================================================
--- trunk/docs/reference/libsoup-2.4-sections.txt	(original)
+++ trunk/docs/reference/libsoup-2.4-sections.txt	Wed Jan 21 17:15:35 2009
@@ -374,11 +374,12 @@
 <SUBSECTION>
 soup_session_get_async_context
 <SUBSECTION>
-SoupSessionFeature
 soup_session_add_feature
 soup_session_add_feature_by_type
 soup_session_remove_feature
 soup_session_remove_feature_by_type
+soup_session_get_feature
+soup_session_get_features
 <SUBSECTION>
 SOUP_SESSION_PROXY_URI
 SOUP_SESSION_MAX_CONNS
@@ -401,17 +402,6 @@
 SOUP_TYPE_SESSION
 SoupSessionClass
 soup_session_get_type
-<SUBSECTION Private>
-soup_session_feature_attach
-soup_session_feature_detach
-SoupSessionFeatureInterface
-soup_session_feature_get_type
-SOUP_SESSION_FEATURE
-SOUP_SESSION_FEATURE_CLASS
-SOUP_SESSION_FEATURE_GET_CLASS
-SOUP_IS_SESSION_FEATURE
-SOUP_IS_SESSION_FEATURE_CLASS
-SOUP_TYPE_SESSION_FEATURE
 </SECTION>
 
 <SECTION>
@@ -449,6 +439,24 @@
 </SECTION>
 
 <SECTION>
+<FILE>soup-session-feature</FILE>
+<TITLE>SoupSessionFeature</TITLE>
+SoupSessionFeature
+SoupSessionFeatureInterface
+<SUBSECTION Standard>
+soup_session_feature_get_type
+SOUP_SESSION_FEATURE
+SOUP_SESSION_FEATURE_CLASS
+SOUP_SESSION_FEATURE_GET_CLASS
+SOUP_IS_SESSION_FEATURE
+SOUP_IS_SESSION_FEATURE_CLASS
+SOUP_TYPE_SESSION_FEATURE
+<SUBSECTION Private>
+soup_session_feature_attach
+soup_session_feature_detach
+</SECTION>
+
+<SECTION>
 <FILE>soup-auth</FILE>
 <TITLE>SoupAuth</TITLE>
 SoupAuth

Modified: trunk/libsoup/soup-session-feature.c
==============================================================================
--- trunk/libsoup/soup-session-feature.c	(original)
+++ trunk/libsoup/soup-session-feature.c	Wed Jan 21 17:15:35 2009
@@ -27,10 +27,22 @@
 /**
  * SoupSessionFeature:
  *
- * The interface implemented by objects that implement features for
+ * An object that implement some sort of optional feature for
  * #SoupSession.
  **/
 
+/**
+ * SoupSessionFeatureInterface:
+ * @parent: The parent interface.
+ * @attach: Perform setup when a feature is added to a session
+ * @detach: Perform cleanup when a feature is removed from a session
+ * @request_queued: Proxies the session's #SoupSession::request_queued signal
+ * @request_started: Proxies the session's #SoupSession::request_started signal
+ * @request_unqueued: Proxies the session's #SoupSession::request_unqueued signal
+ *
+ * The interface implemented by #SoupSessionFeature<!-- -->s.
+ **/
+
 static void soup_session_feature_interface_init (SoupSessionFeatureInterface *interface);
 
 static void attach (SoupSessionFeature *feature, SoupSession *session);

Modified: trunk/libsoup/soup-session-feature.h
==============================================================================
--- trunk/libsoup/soup-session-feature.h	(original)
+++ trunk/libsoup/soup-session-feature.h	Wed Jan 21 17:15:35 2009
@@ -17,17 +17,14 @@
 #define SOUP_IS_SESSION_FEATURE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), SOUP_TYPE_SESSION_FEATURE))
 #define SOUP_SESSION_FEATURE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), SOUP_TYPE_SESSION_FEATURE, SoupSessionFeatureInterface))
 
-/* dummy struct for gtk-doc */
-struct _SoupSessionFeature {};
-
 typedef struct {
 	GTypeInterface parent;
 
 	/* methods */
-	void (*attach) (SoupSessionFeature *feature,
-			SoupSession        *session);
-	void (*detach) (SoupSessionFeature *feature,
-			SoupSession        *session);
+	void (*attach)           (SoupSessionFeature *feature,
+				  SoupSession        *session);
+	void (*detach)           (SoupSessionFeature *feature,
+				  SoupSession        *session);
 
 	void (*request_queued)   (SoupSessionFeature *feature,
 				  SoupSession        *session,