summaryrefslogtreecommitdiff
path: root/libsoup/soup-auth.c
diff options
context:
space:
mode:
authorDan Winship <danw@src.gnome.org>2008-01-07 14:51:31 +0000
committerDan Winship <danw@src.gnome.org>2008-01-07 14:51:31 +0000
commitb3a34e8a0197507c9df377d15d58b3453521cb9f (patch)
tree885039cc2eecb4d175f02a93bf83430f019648ef /libsoup/soup-auth.c
parentdf65b937db738566ab719d4b75dde8628fcb8996 (diff)
downloadlibsoup-b3a34e8a0197507c9df377d15d58b3453521cb9f.tar.gz
Move gtk-doc stuff from docs/reference/tmpl/ to the C files themselves.
* libsoup/*.c: Move gtk-doc stuff from docs/reference/tmpl/ to the C files themselves. Some updates. * docs/reference/Makefile.am: fix (kludge?) this up to not require tmpl/ to exist * docs/reference/client-howto.xml: * docs/reference/server-howto.xml: update svn path=/branches/libsoup-2.4/; revision=1018
Diffstat (limited to 'libsoup/soup-auth.c')
-rw-r--r--libsoup/soup-auth.c19
1 files changed, 19 insertions, 0 deletions
diff --git a/libsoup/soup-auth.c b/libsoup/soup-auth.c
index 3e8b4a49..30792814 100644
--- a/libsoup/soup-auth.c
+++ b/libsoup/soup-auth.c
@@ -17,6 +17,25 @@
#include "soup-headers.h"
#include "soup-uri.h"
+/**
+ * SECTION:soup-auth
+ * @short_description: HTTP client-side authentication support
+ * @see_also: #SoupSession
+ *
+ * #SoupAuth objects store the authentication data associated with a
+ * given bit of web space. They are created automatically by
+ * #SoupSession.
+ **/
+
+/**
+ * SoupAuth:
+ *
+ * The abstract base class for handling authentication. Specific HTTP
+ * Authentication mechanisms are implemented by its subclasses, but
+ * applications never need to be aware of the specific subclasses
+ * being used.
+ **/
+
typedef struct {
gboolean proxy;
char *host;