loudmouth/lm-proxy.c
changeset 417 364c17252e5f
parent 407 4401f2aa0692
child 420 f40434cca022
--- a/loudmouth/lm-proxy.c	Fri Jun 20 17:14:45 2008 +0200
+++ b/loudmouth/lm-proxy.c	Sat Jun 21 13:19:21 2008 +0200
@@ -19,6 +19,23 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:LmProxy
+ * @Short_description: API for the proxy support in Loudmouth
+ * 
+ * Use this together with an #LmConnection to get the connection to use connect through a proxy. Example of how to use the #LmProxy API.
+ * <informalexample><programlisting><![CDATA[
+ * LmConnection *connection;
+ * LmProxy      *proxy;
+ * 
+ * connection = lm_connection_new ("myserver");
+ * proxy = lm_proxy_new_with_server (LM_PROXY_TYPE_HTTP,
+ * 				  "myproxyserver",
+ * 				  8080);
+ * lm_connection_set_proxy (connection, proxy);
+ * ...]]></programlisting></informalexample>
+ */
+
 #include <config.h>
 
 #include <glib.h>